Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1 | # NB NB NB NB NB NB NB NB NB NB NB |
| 2 | # |
| 3 | # NOTE: The API binary wrappers in this file are in the process of being |
| 4 | # deprecated. DO NOT ADD NEW WRAPPERS HERE. Call the functions using |
| 5 | # named arguments directly instead. |
| 6 | # |
| 7 | |
Paul Vinciguerra | 00671cf | 2018-11-25 12:47:04 -0800 | [diff] [blame] | 8 | import os |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 9 | import time |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 10 | from collections import deque |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 11 | |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 12 | from six import moves, iteritems |
Paul Vinciguerra | 1954229 | 2019-03-17 17:34:46 -0700 | [diff] [blame] | 13 | from vpp_papi import VPPApiClient, mac_pton |
Paul Vinciguerra | 00671cf | 2018-11-25 12:47:04 -0800 | [diff] [blame] | 14 | from hook import Hook |
Paul Vinciguerra | b5f15bd | 2019-03-17 08:42:58 -0700 | [diff] [blame] | 15 | from vpp_ip_route import MPLS_IETF_MAX_LABEL, MPLS_LABEL_INVALID |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 16 | |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 17 | |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 18 | # |
| 19 | # Dictionary keyed on message name to override default values for |
| 20 | # named parameters |
| 21 | # |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 22 | defaultmapping = { |
| 23 | 'map_add_domain': {'mtu': 1280}, |
| 24 | 'syslog_set_sender': {'collector_port': 514, |
| 25 | 'max_msg_size': 480}, |
| 26 | 'acl_interface_add_del': {'is_add': 1, 'is_input': 1}, |
| 27 | 'acl_interface_list_dump': {'sw_if_index': 4294967295, }, |
| 28 | 'app_namespace_add_del': {'sw_if_index': 4294967295, }, |
| 29 | 'bd_ip_mac_add_del': {'is_add': 1, }, |
Jakub Grajciar | 4682feb | 2019-09-02 13:28:52 +0200 | [diff] [blame] | 30 | 'bfd_udp_add': {'is_authenticated': False, 'bfd_key_id': None, |
| 31 | 'conf_key_id': None}, |
| 32 | 'bfd_udp_auth_activate': {'bfd_key_id': None, 'conf_key_id': None, |
| 33 | 'is_delayed': False}, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 34 | 'bier_disp_entry_add_del': {'next_hop_rpf_id': -1, 'next_hop_is_ip4': 1, |
| 35 | 'is_add': 1, }, |
| 36 | 'bier_disp_table_add_del': {'is_add': 1, }, |
| 37 | 'bier_imp_add': {'is_add': 1, }, |
| 38 | 'bier_route_add_del': {'is_add': 1, }, |
| 39 | 'bier_table_add_del': {'is_add': 1, }, |
Jakub Grajciar | 3d1ef87 | 2019-08-26 12:55:15 +0200 | [diff] [blame] | 40 | 'bond_create': {'mac_address': '', 'id': 0xFFFFFFFF}, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 41 | 'bridge_domain_add_del': {'flood': 1, 'uu_flood': 1, 'forward': 1, |
| 42 | 'learn': 1, 'is_add': 1, }, |
Paul Vinciguerra | 9a29f79 | 2019-04-30 20:44:25 -0700 | [diff] [blame] | 43 | 'bvi_create': {'user_instance': 4294967295, }, |
| 44 | 'bvi_delete': {}, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 45 | 'gbp_subnet_add_del': {'sw_if_index': 4294967295, 'epg_id': 65535, }, |
| 46 | 'geneve_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, |
| 47 | 'decap_next_index': 4294967295, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 48 | 'input_acl_set_interface': {'ip4_table_index': 4294967295, |
| 49 | 'ip6_table_index': 4294967295, |
| 50 | 'l2_table_index': 4294967295, }, |
| 51 | 'ip6_add_del_address_using_prefix': {'is_add': 1, }, |
| 52 | 'ip6nd_send_router_solicitation': {'irt': 1, 'mrt': 120, }, |
| 53 | 'ip_add_del_route': {'next_hop_sw_if_index': 4294967295, |
| 54 | 'next_hop_weight': 1, 'next_hop_via_label': 1048576, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 55 | 'classify_table_index': 4294967295, 'is_add': 1, }, |
| 56 | 'ip_mroute_add_del': {'is_add': 1, }, |
| 57 | 'ip_neighbor_add_del': {'is_add': 1, }, |
| 58 | 'ip_punt_police': {'is_add': 1, }, |
| 59 | 'ip_punt_redirect': {'is_add': 1, }, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 60 | 'ip_route_add_del': {'is_add': 1, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 61 | 'ip_unnumbered_dump': {'sw_if_index': 4294967295, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 62 | 'ipsec_interface_add_del_spd': {'is_add': 1, }, |
| 63 | 'ipsec_sad_entry_add_del': {'is_add': 1, }, |
| 64 | 'ipsec_spd_add_del': {'is_add': 1, }, |
| 65 | 'ipsec_spd_dump': {'sa_id': 4294967295, }, |
| 66 | 'ipsec_spd_entry_add_del': {'local_port_stop': 65535, |
| 67 | 'remote_port_stop': 65535, 'priority': 100, |
| 68 | 'is_outbound': 1, |
| 69 | 'is_add': 1, }, |
| 70 | 'ipsec_tunnel_if_add_del': {'is_add': 1, 'anti_replay': 1, }, |
| 71 | 'l2_emulation': {'enable': 1, }, |
| 72 | 'l2fib_add_del': {'is_add': 1, }, |
Paul Vinciguerra | f7f1334 | 2019-03-19 11:54:39 -0700 | [diff] [blame] | 73 | 'lb_conf': {'sticky_buckets_per_core': 4294967295, |
| 74 | 'flow_timeout': 4294967295}, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 75 | 'lisp_add_del_adjacency': {'is_add': 1, }, |
| 76 | 'lisp_add_del_local_eid': {'is_add': 1, }, |
| 77 | 'lisp_add_del_locator': {'priority': 1, 'weight': 1, 'is_add': 1, }, |
| 78 | 'lisp_add_del_locator_set': {'is_add': 1, }, |
| 79 | 'lisp_add_del_remote_mapping': {'is_add': 1, }, |
| 80 | 'macip_acl_add_replace': {'acl_index': 4294967295, }, |
| 81 | 'macip_acl_dump': {'acl_index': 4294967295, }, |
| 82 | 'macip_acl_interface_add_del': {'is_add': 1, }, |
| 83 | 'mpls_ip_bind_unbind': {'is_ip4': 1, 'is_bind': 1, }, |
Ole Troan | a5b2eec | 2019-03-11 19:23:25 +0100 | [diff] [blame] | 84 | 'mpls_route_add_del': {'mr_next_hop_sw_if_index': 4294967295, |
| 85 | 'mr_next_hop_weight': 1, |
| 86 | 'mr_next_hop_via_label': 1048576, |
| 87 | 'mr_is_add': 1, |
| 88 | 'mr_classify_table_index': 4294967295, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 89 | 'mpls_table_add_del': {'is_add': 1, }, |
| 90 | 'mpls_tunnel_add_del': {'next_hop_sw_if_index': 4294967295, |
| 91 | 'next_hop_weight': 1, |
| 92 | 'next_hop_via_label': 1048576, |
| 93 | 'is_add': 1, }, |
| 94 | 'mpls_tunnel_dump': {'sw_if_index': 4294967295, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 95 | 'output_acl_set_interface': {'ip4_table_index': 4294967295, |
| 96 | 'ip6_table_index': 4294967295, |
| 97 | 'l2_table_index': 4294967295, }, |
| 98 | 'pppoe_add_del_session': {'is_add': 1, }, |
Jakub Grajciar | cd01fb4 | 2020-03-02 13:16:53 +0100 | [diff] [blame] | 99 | 'policer_add_del': {'is_add': 1, 'conform_action': {'type': 1}, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 100 | 'proxy_arp_add_del': {'is_add': 1, }, |
| 101 | 'proxy_arp_intfc_enable_disable': {'is_enable': 1, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 102 | 'set_ip_flow_hash': {'src': 1, 'dst': 1, 'sport': 1, 'dport': 1, |
| 103 | 'proto': 1, }, |
| 104 | 'set_ipfix_exporter': {'collector_port': 4739, }, |
| 105 | 'sr_localsid_add_del': {'sw_if_index': 4294967295, }, |
| 106 | 'sr_policy_add': {'weight': 1, 'is_encap': 1, }, |
| 107 | 'svs_enable_disable': {'is_enable': 1, }, |
| 108 | 'svs_route_add_del': {'is_add': 1, }, |
| 109 | 'svs_table_add_del': {'is_add': 1, }, |
| 110 | 'sw_interface_add_del_address': {'is_add': 1, }, |
Paul Vinciguerra | 6407ba5 | 2019-04-04 13:22:20 -0700 | [diff] [blame] | 111 | 'sw_interface_dump': {'sw_if_index': 4294967295, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 112 | 'sw_interface_ip6nd_ra_prefix': {'val_lifetime': 4294967295, |
| 113 | 'pref_lifetime': 4294967295, }, |
| 114 | 'sw_interface_set_ip_directed_broadcast': {'enable': 1, }, |
| 115 | 'sw_interface_set_l2_bridge': {'enable': 1, }, |
| 116 | 'sw_interface_set_mpls_enable': {'enable': 1, }, |
| 117 | 'sw_interface_set_mtu': {'mtu': [0, 0, 0, 0], }, |
| 118 | 'sw_interface_set_unnumbered': {'is_add': 1, }, |
| 119 | 'sw_interface_span_enable_disable': {'state': 1, }, |
| 120 | 'vxlan_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, |
| 121 | 'decap_next_index': 4294967295, |
| 122 | 'instance': 4294967295, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 123 | 'vxlan_gbp_tunnel_dump': {'sw_if_index': 4294967295, }, |
| 124 | 'vxlan_gpe_add_del_tunnel': {'mcast_sw_if_index': 4294967295, 'is_add': 1, |
| 125 | 'protocol': 3, }, |
| 126 | 'want_bfd_events': {'enable_disable': 1, }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 127 | 'want_igmp_events': {'enable': 1, }, |
| 128 | 'want_interface_events': {'enable_disable': 1, }, |
Jakub Grajciar | 145e330 | 2019-10-24 13:52:42 +0200 | [diff] [blame] | 129 | 'want_l2_macs_events': {'enable_disable': 1, 'pid': os.getpid(), }, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 130 | } |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 131 | |
Matus Fabian | b4515b4 | 2018-11-19 04:25:32 -0800 | [diff] [blame] | 132 | |
Paul Vinciguerra | 9673e3e | 2019-05-10 20:41:08 -0400 | [diff] [blame] | 133 | class CliFailedCommandError(Exception): |
| 134 | """ cli command failed.""" |
| 135 | |
| 136 | |
| 137 | class CliSyntaxError(Exception): |
| 138 | """ cli command had a syntax error.""" |
| 139 | |
| 140 | |
Klement Sekera | 7388448 | 2017-02-23 09:26:30 +0100 | [diff] [blame] | 141 | class UnexpectedApiReturnValueError(Exception): |
| 142 | """ exception raised when the API return value is unexpected """ |
| 143 | pass |
| 144 | |
| 145 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 146 | class VppPapiProvider(object): |
| 147 | """VPP-api provider using vpp-papi |
| 148 | |
| 149 | @property hook: hook object providing before and after api/cli hooks |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 150 | """ |
| 151 | |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 152 | _zero, _negative = range(2) |
| 153 | |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 154 | def __init__(self, name, shm_prefix, test_class, read_timeout): |
Paul Vinciguerra | 895e2f8 | 2019-01-08 20:37:40 -0800 | [diff] [blame] | 155 | self.hook = Hook(test_class) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 156 | self.name = name |
| 157 | self.shm_prefix = shm_prefix |
Klement Sekera | 7bb873a | 2016-11-18 07:38:42 +0100 | [diff] [blame] | 158 | self.test_class = test_class |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 159 | self._expect_api_retval = self._zero |
| 160 | self._expect_stack = [] |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 161 | |
Paul Vinciguerra | 1954229 | 2019-03-17 17:34:46 -0700 | [diff] [blame] | 162 | # install_dir is a class attribute. We need to set it before |
| 163 | # calling the constructor. |
| 164 | VPPApiClient.apidir = os.getenv('VPP_INSTALL_PATH') |
Paul Vinciguerra | 04575c5 | 2019-01-13 10:26:05 -0800 | [diff] [blame] | 165 | |
Ole Troan | 4ff09ae | 2019-04-15 11:27:22 +0200 | [diff] [blame] | 166 | use_socket = False |
| 167 | try: |
| 168 | if os.environ['SOCKET'] == '1': |
| 169 | use_socket = True |
Paul Vinciguerra | bff9f2f | 2019-05-09 16:12:35 -0400 | [diff] [blame] | 170 | except KeyError: |
Ole Troan | 4ff09ae | 2019-04-15 11:27:22 +0200 | [diff] [blame] | 171 | pass |
Paul Vinciguerra | 1954229 | 2019-03-17 17:34:46 -0700 | [diff] [blame] | 172 | |
| 173 | self.vpp = VPPApiClient(logger=test_class.logger, |
| 174 | read_timeout=read_timeout, |
| 175 | use_socket=use_socket, |
| 176 | server_address=test_class.api_sock) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 177 | self._events = deque() |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 178 | |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 179 | def __enter__(self): |
| 180 | return self |
| 181 | |
Klement Sekera | 7d6afb3 | 2018-11-08 11:52:04 +0100 | [diff] [blame] | 182 | def assert_negative_api_retval(self): |
| 183 | """ Expect API failure - used with with, e.g.: |
| 184 | with self.vapi.assert_negative_api_retval(): |
| 185 | self.vapi.<api call expected to fail> |
| 186 | """ |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 187 | self._expect_stack.append(self._expect_api_retval) |
| 188 | self._expect_api_retval = self._negative |
| 189 | return self |
| 190 | |
Klement Sekera | 7d6afb3 | 2018-11-08 11:52:04 +0100 | [diff] [blame] | 191 | def assert_zero_api_retval(self): |
| 192 | """ Expect API success - used with with, e.g.: |
| 193 | with self.vapi.assert_negative_api_retval(): |
| 194 | self.vapi.<api call expected to succeed> |
| 195 | |
| 196 | note: this is useful only inside another with block |
| 197 | as success is the default expected value |
| 198 | """ |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 199 | self._expect_stack.append(self._expect_api_retval) |
| 200 | self._expect_api_retval = self._zero |
| 201 | return self |
| 202 | |
| 203 | def __exit__(self, exc_type, exc_value, traceback): |
| 204 | self._expect_api_retval = self._expect_stack.pop() |
| 205 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 206 | def register_hook(self, hook): |
| 207 | """Replace hook registration with new hook |
| 208 | |
| 209 | :param hook: |
| 210 | |
| 211 | """ |
| 212 | self.hook = hook |
| 213 | |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 214 | def collect_events(self): |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 215 | """ Collect all events from the internal queue and clear the queue. """ |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 216 | e = self._events |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 217 | self._events = deque() |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 218 | return e |
| 219 | |
| 220 | def wait_for_event(self, timeout, name=None): |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 221 | """ Wait for and return next event. """ |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 222 | if name: |
Klement Sekera | acb9b8e | 2017-02-14 02:55:31 +0100 | [diff] [blame] | 223 | self.test_class.logger.debug("Expecting event '%s' within %ss", |
| 224 | name, timeout) |
Eyal Bari | 2019748 | 2017-09-13 12:29:08 +0300 | [diff] [blame] | 225 | else: |
| 226 | self.test_class.logger.debug("Expecting event within %ss", |
| 227 | timeout) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 228 | if self._events: |
| 229 | self.test_class.logger.debug("Not waiting, event already queued") |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 230 | limit = time.time() + timeout |
| 231 | while time.time() < limit: |
| 232 | if self._events: |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 233 | e = self._events.popleft() |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 234 | if name and type(e).__name__ != name: |
| 235 | raise Exception( |
| 236 | "Unexpected event received: %s, expected: %s" % |
| 237 | (type(e).__name__, name)) |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 238 | self.test_class.logger.debug("Returning event %s:%s" % |
| 239 | (name, e)) |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 240 | return e |
Paul Vinciguerra | 0f6602c | 2019-03-10 09:10:54 -0700 | [diff] [blame] | 241 | self.test_class.sleep(0) # yield |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 242 | raise Exception("Event did not occur within timeout") |
| 243 | |
| 244 | def __call__(self, name, event): |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 245 | """ Enqueue event in the internal event queue. """ |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 246 | # FIXME use the name instead of relying on type(e).__name__ ? |
| 247 | # FIXME #2 if this throws, it is eaten silently, Ole? |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 248 | self.test_class.logger.debug("New event: %s: %s" % (name, event)) |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 249 | self._events.append(event) |
| 250 | |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 251 | def factory(self, name, apifn): |
| 252 | def f(*a, **ka): |
| 253 | fields = apifn._func.msg.fields |
| 254 | |
| 255 | # add positional and kw arguments |
| 256 | d = ka |
| 257 | for i, o in enumerate(fields[3:]): |
| 258 | try: |
| 259 | d[o] = a[i] |
Jakub Grajciar | 4682feb | 2019-09-02 13:28:52 +0200 | [diff] [blame] | 260 | except BaseException: |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 261 | break |
| 262 | |
| 263 | # Default override |
| 264 | if name in defaultmapping: |
| 265 | for k, v in iteritems(defaultmapping[name]): |
| 266 | if k in d: |
| 267 | continue |
| 268 | d[k] = v |
| 269 | return self.api(apifn, d) |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 270 | |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 271 | return f |
| 272 | |
Paul Vinciguerra | 7ab9970 | 2019-03-05 04:30:04 -0800 | [diff] [blame] | 273 | def __getattribute__(self, name): |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 274 | try: |
Paul Vinciguerra | 7ab9970 | 2019-03-05 04:30:04 -0800 | [diff] [blame] | 275 | method = super(VppPapiProvider, self).__getattribute__(name) |
| 276 | except AttributeError: |
| 277 | method = self.factory(name, getattr(self.papi, name)) |
| 278 | # lazily load the method so we don't need to call factory |
| 279 | # again for this name. |
| 280 | setattr(self, name, method) |
| 281 | return method |
Ole Troan | f159f58 | 2019-02-28 20:20:47 +0100 | [diff] [blame] | 282 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 283 | def connect(self): |
| 284 | """Connect the API to VPP""" |
Klement Sekera | 7112c54 | 2017-03-01 09:53:19 +0100 | [diff] [blame] | 285 | self.vpp.connect(self.name, self.shm_prefix) |
| 286 | self.papi = self.vpp.api |
| 287 | self.vpp.register_event_callback(self) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 288 | |
| 289 | def disconnect(self): |
| 290 | """Disconnect the API from VPP""" |
Klement Sekera | 7112c54 | 2017-03-01 09:53:19 +0100 | [diff] [blame] | 291 | self.vpp.disconnect() |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 292 | |
| 293 | def api(self, api_fn, api_args, expected_retval=0): |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 294 | """ Call API function and check it's return value. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 295 | Call the appropriate hooks before and after the API call |
| 296 | |
| 297 | :param api_fn: API function to call |
| 298 | :param api_args: tuple of API function arguments |
| 299 | :param expected_retval: Expected return value (Default value = 0) |
| 300 | :returns: reply from the API |
| 301 | |
| 302 | """ |
| 303 | self.hook.before_api(api_fn.__name__, api_args) |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 304 | reply = api_fn(**api_args) |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 305 | if self._expect_api_retval == self._negative: |
| 306 | if hasattr(reply, 'retval') and reply.retval >= 0: |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 307 | msg = "API call passed unexpectedly: expected negative " \ |
| 308 | "return value instead of %d in %s" % \ |
| 309 | (reply.retval, moves.reprlib.repr(reply)) |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 310 | self.test_class.logger.info(msg) |
Klement Sekera | 7388448 | 2017-02-23 09:26:30 +0100 | [diff] [blame] | 311 | raise UnexpectedApiReturnValueError(msg) |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 312 | elif self._expect_api_retval == self._zero: |
| 313 | if hasattr(reply, 'retval') and reply.retval != expected_retval: |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 314 | msg = "API call failed, expected %d return value instead " \ |
| 315 | "of %d in %s" % (expected_retval, reply.retval, |
Paul Vinciguerra | 1b534f5 | 2019-06-15 20:31:31 -0400 | [diff] [blame] | 316 | repr(reply)) |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 317 | self.test_class.logger.info(msg) |
Klement Sekera | 7388448 | 2017-02-23 09:26:30 +0100 | [diff] [blame] | 318 | raise UnexpectedApiReturnValueError(msg) |
Klement Sekera | e0545ef | 2017-01-25 08:00:40 +0100 | [diff] [blame] | 319 | else: |
| 320 | raise Exception("Internal error, unexpected value for " |
| 321 | "self._expect_api_retval %s" % |
| 322 | self._expect_api_retval) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 323 | self.hook.after_api(api_fn.__name__, api_args) |
| 324 | return reply |
| 325 | |
Dave Barach | 5932ce1 | 2019-10-09 17:28:04 -0400 | [diff] [blame] | 326 | def cli_return_response(self, cli): |
| 327 | """ Execute a CLI, calling the before/after hooks appropriately. |
| 328 | Return the reply without examining it |
| 329 | |
| 330 | :param cli: CLI to execute |
| 331 | :returns: response object |
| 332 | |
| 333 | """ |
| 334 | self.hook.before_cli(cli) |
| 335 | cli += '\n' |
| 336 | r = self.papi.cli_inband(cmd=cli) |
| 337 | self.hook.after_cli(cli) |
| 338 | return r |
| 339 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 340 | def cli(self, cli): |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 341 | """ Execute a CLI, calling the before/after hooks appropriately. |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 342 | |
| 343 | :param cli: CLI to execute |
| 344 | :returns: CLI output |
| 345 | |
| 346 | """ |
Dave Barach | 5932ce1 | 2019-10-09 17:28:04 -0400 | [diff] [blame] | 347 | r = self.cli_return_response(cli) |
Paul Vinciguerra | 9673e3e | 2019-05-10 20:41:08 -0400 | [diff] [blame] | 348 | if r.retval == -156: |
| 349 | raise CliSyntaxError(r.reply) |
| 350 | if r.retval != 0: |
| 351 | raise CliFailedCommandError(r.reply) |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 352 | if hasattr(r, 'reply'): |
Ole Troan | 413f4a5 | 2018-11-28 11:36:05 +0100 | [diff] [blame] | 353 | return r.reply |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 354 | |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 355 | def ppcli(self, cli): |
Klement Sekera | e4504c6 | 2016-12-08 10:16:41 +0100 | [diff] [blame] | 356 | """ Helper method to print CLI command in case of info logging level. |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 357 | |
| 358 | :param cli: CLI to execute |
| 359 | :returns: CLI output |
| 360 | """ |
Ole Troan | 6ed154f | 2019-10-15 19:31:55 +0200 | [diff] [blame] | 361 | return cli + "\n" + self.cli(cli) |
Jan | 49c0fca | 2016-10-26 15:44:27 +0200 | [diff] [blame] | 362 | |
Juraj Sloboda | 4b9669d | 2018-01-15 10:39:21 +0100 | [diff] [blame] | 363 | def ip6nd_send_router_solicitation(self, sw_if_index, irt=1, mrt=120, |
| 364 | mrc=0, mrd=0): |
| 365 | return self.api(self.papi.ip6nd_send_router_solicitation, |
| 366 | {'irt': irt, |
| 367 | 'mrt': mrt, |
| 368 | 'mrc': mrc, |
| 369 | 'mrd': mrd, |
| 370 | 'sw_if_index': sw_if_index}) |
| 371 | |
Juraj Sloboda | b3f9050 | 2018-10-04 15:15:16 +0200 | [diff] [blame] | 372 | def want_interface_events(self, enable_disable=1): |
| 373 | return self.api(self.papi.want_interface_events, |
| 374 | {'enable_disable': enable_disable, |
| 375 | 'pid': os.getpid(), }) |
| 376 | |
Neale Ranns | c819fc6 | 2018-02-16 02:44:05 -0800 | [diff] [blame] | 377 | def sw_interface_set_mac_address(self, sw_if_index, mac): |
| 378 | return self.api(self.papi.sw_interface_set_mac_address, |
| 379 | {'sw_if_index': sw_if_index, |
| 380 | 'mac_address': mac}) |
| 381 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 382 | def p2p_ethernet_add(self, sw_if_index, remote_mac, subif_id): |
Pavel Kotucek | 15ac81c | 2017-06-20 14:00:26 +0200 | [diff] [blame] | 383 | """Create p2p ethernet subinterface |
| 384 | |
| 385 | :param sw_if_index: main (parent) interface |
| 386 | :param remote_mac: client (remote) mac address |
| 387 | |
| 388 | """ |
| 389 | return self.api( |
| 390 | self.papi.p2p_ethernet_add, |
| 391 | {'parent_if_index': sw_if_index, |
| 392 | 'remote_mac': remote_mac, |
| 393 | 'subif_id': subif_id}) |
| 394 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 395 | def p2p_ethernet_del(self, sw_if_index, remote_mac): |
Pavel Kotucek | 15ac81c | 2017-06-20 14:00:26 +0200 | [diff] [blame] | 396 | """Delete p2p ethernet subinterface |
| 397 | |
| 398 | :param sw_if_index: main (parent) interface |
| 399 | :param remote_mac: client (remote) mac address |
| 400 | |
| 401 | """ |
| 402 | return self.api( |
| 403 | self.papi.p2p_ethernet_del, |
| 404 | {'parent_if_index': sw_if_index, |
| 405 | 'remote_mac': remote_mac}) |
| 406 | |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 407 | def create_vlan_subif(self, sw_if_index, vlan): |
| 408 | """ |
| 409 | |
| 410 | :param vlan: |
| 411 | :param sw_if_index: |
| 412 | |
| 413 | """ |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 414 | return self.api(self.papi.create_vlan_subif, |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 415 | {'sw_if_index': sw_if_index, |
| 416 | 'vlan_id': vlan}) |
Klement Sekera | f62ae12 | 2016-10-11 11:47:09 +0200 | [diff] [blame] | 417 | |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 418 | def create_loopback(self, mac=''): |
| 419 | """ |
| 420 | |
| 421 | :param mac: (Optional) |
| 422 | """ |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 423 | return self.api(self.papi.create_loopback, |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 424 | {'mac_address': mac}) |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 425 | |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 426 | def ip_route_dump(self, table_id, is_ip6=False): |
| 427 | return self.api(self.papi.ip_route_dump, |
| 428 | {'table': { |
| 429 | 'table_id': table_id, |
| 430 | 'is_ip6': is_ip6 |
| 431 | }}) |
| 432 | |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 433 | def ip_neighbor_add_del(self, |
| 434 | sw_if_index, |
| 435 | mac_address, |
Neale Ranns | 3702930 | 2018-08-10 05:30:06 -0700 | [diff] [blame] | 436 | ip_address, |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 437 | is_add=1, |
Neale Ranns | 3702930 | 2018-08-10 05:30:06 -0700 | [diff] [blame] | 438 | flags=0): |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 439 | """ Add neighbor MAC to IPv4 or IPv6 address. |
| 440 | |
| 441 | :param sw_if_index: |
| 442 | :param mac_address: |
| 443 | :param dst_address: |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 444 | :param is_add: (Default value = 1) |
Neale Ranns | 3702930 | 2018-08-10 05:30:06 -0700 | [diff] [blame] | 445 | :param flags: (Default value = 0/NONE) |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 446 | """ |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 447 | return self.api( |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 448 | self.papi.ip_neighbor_add_del, |
Neale Ranns | 3702930 | 2018-08-10 05:30:06 -0700 | [diff] [blame] | 449 | { |
| 450 | 'is_add': is_add, |
| 451 | 'neighbor': { |
| 452 | 'sw_if_index': sw_if_index, |
| 453 | 'flags': flags, |
| 454 | 'mac_address': mac_address, |
| 455 | 'ip_address': ip_address |
| 456 | } |
| 457 | } |
Matej Klotton | 0178d52 | 2016-11-04 11:11:44 +0100 | [diff] [blame] | 458 | ) |
Pavel Kotucek | f6e3dc4 | 2016-11-04 09:58:01 +0100 | [diff] [blame] | 459 | |
Neale Ranns | 39f9d8b | 2017-02-16 21:57:05 -0800 | [diff] [blame] | 460 | def proxy_arp_add_del(self, |
Neale Ranns | 3702930 | 2018-08-10 05:30:06 -0700 | [diff] [blame] | 461 | low, |
| 462 | hi, |
| 463 | table_id=0, |
Neale Ranns | 39f9d8b | 2017-02-16 21:57:05 -0800 | [diff] [blame] | 464 | is_add=1): |
| 465 | """ Config Proxy Arp Range. |
| 466 | |
| 467 | :param low_address: Start address in the rnage to Proxy for |
| 468 | :param hi_address: End address in the rnage to Proxy for |
| 469 | :param vrf_id: The VRF/table in which to proxy |
| 470 | """ |
| 471 | |
| 472 | return self.api( |
| 473 | self.papi.proxy_arp_add_del, |
Neale Ranns | 0053de6 | 2018-05-22 08:40:52 -0700 | [diff] [blame] | 474 | {'proxy': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 475 | { |
| 476 | 'table_id': table_id, |
| 477 | 'low': low, |
| 478 | 'hi': hi, |
| 479 | }, |
| 480 | 'is_add': is_add}) |
Neale Ranns | 39f9d8b | 2017-02-16 21:57:05 -0800 | [diff] [blame] | 481 | |
| 482 | def proxy_arp_intfc_enable_disable(self, |
| 483 | sw_if_index, |
| 484 | is_enable=1): |
| 485 | """ Enable/Disable an interface for proxy ARP requests |
| 486 | |
| 487 | :param sw_if_index: Interface |
| 488 | :param enable_disable: Enable/Disable |
| 489 | """ |
| 490 | |
| 491 | return self.api( |
| 492 | self.papi.proxy_arp_intfc_enable_disable, |
| 493 | {'sw_if_index': sw_if_index, |
Neale Ranns | cbe25aa | 2019-09-30 10:53:31 +0000 | [diff] [blame] | 494 | 'enable': is_enable |
Neale Ranns | 39f9d8b | 2017-02-16 21:57:05 -0800 | [diff] [blame] | 495 | } |
| 496 | ) |
| 497 | |
Neale Ranns | d0df49f | 2018-08-08 01:06:40 -0700 | [diff] [blame] | 498 | def udp_encap_add(self, |
Neale Ranns | d0df49f | 2018-08-08 01:06:40 -0700 | [diff] [blame] | 499 | src_ip, |
| 500 | dst_ip, |
| 501 | src_port, |
| 502 | dst_port, |
| 503 | table_id=0): |
Neale Ranns | 810086d | 2017-11-05 16:26:46 -0800 | [diff] [blame] | 504 | """ Add a GRE tunnel |
Neale Ranns | 810086d | 2017-11-05 16:26:46 -0800 | [diff] [blame] | 505 | :param src_ip: |
| 506 | :param dst_ip: |
| 507 | :param src_port: |
| 508 | :param dst_port: |
| 509 | :param outer_fib_id: (Default value = 0) |
Neale Ranns | 810086d | 2017-11-05 16:26:46 -0800 | [diff] [blame] | 510 | """ |
| 511 | |
| 512 | return self.api( |
Neale Ranns | d0df49f | 2018-08-08 01:06:40 -0700 | [diff] [blame] | 513 | self.papi.udp_encap_add, |
| 514 | { |
| 515 | 'udp_encap': { |
Neale Ranns | d0df49f | 2018-08-08 01:06:40 -0700 | [diff] [blame] | 516 | 'src_ip': src_ip, |
| 517 | 'dst_ip': dst_ip, |
| 518 | 'src_port': src_port, |
| 519 | 'dst_port': dst_port, |
| 520 | 'table_id': table_id |
| 521 | } |
| 522 | }) |
| 523 | |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 524 | def udp_encap_del(self, id): |
| 525 | return self.api(self.papi.udp_encap_del, {'id': id}) |
| 526 | |
| 527 | def udp_encap_dump(self): |
| 528 | return self.api(self.papi.udp_encap_dump, {}) |
| 529 | |
| 530 | def want_udp_encap_stats(self, enable=1): |
| 531 | return self.api(self.papi.want_udp_encap_stats, |
| 532 | {'enable': enable, |
| 533 | 'pid': os.getpid()}) |
| 534 | |
| 535 | def mpls_route_dump(self, table_id): |
| 536 | return self.api(self.papi.mpls_route_dump, |
| 537 | {'table': { |
| 538 | 'mt_table_id': table_id |
| 539 | }}) |
| 540 | |
| 541 | def mpls_table_dump(self): |
| 542 | return self.api(self.papi.mpls_table_dump, {}) |
| 543 | |
Neale Ranns | 1500254 | 2017-09-10 04:39:11 -0700 | [diff] [blame] | 544 | def mpls_table_add_del( |
| 545 | self, |
| 546 | table_id, |
| 547 | is_add=1): |
| 548 | """ |
| 549 | |
| 550 | :param table_id |
| 551 | :param is_add: (Default value = 1) |
| 552 | |
| 553 | """ |
| 554 | |
| 555 | return self.api( |
| 556 | self.papi.mpls_table_add_del, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 557 | {'mt_table': |
| 558 | { |
| 559 | 'mt_table_id': table_id, |
| 560 | }, |
Neale Ranns | 1500254 | 2017-09-10 04:39:11 -0700 | [diff] [blame] | 561 | 'mt_is_add': is_add}) |
| 562 | |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 563 | def mpls_route_add_del(self, |
| 564 | table_id, |
| 565 | label, |
| 566 | eos, |
| 567 | eos_proto, |
| 568 | is_multicast, |
| 569 | paths, |
| 570 | is_add, |
| 571 | is_multipath): |
| 572 | """ MPLS Route add/del """ |
| 573 | return self.api( |
| 574 | self.papi.mpls_route_add_del, |
| 575 | {'mr_route': |
| 576 | { |
| 577 | 'mr_table_id': table_id, |
| 578 | 'mr_label': label, |
| 579 | 'mr_eos': eos, |
| 580 | 'mr_eos_proto': eos_proto, |
| 581 | 'mr_is_multicast': is_multicast, |
| 582 | 'mr_n_paths': len(paths), |
| 583 | 'mr_paths': paths, |
| 584 | }, |
| 585 | 'mr_is_add': is_add, |
| 586 | 'mr_is_multipath': is_multipath}) |
| 587 | |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 588 | def mpls_ip_bind_unbind( |
| 589 | self, |
| 590 | label, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 591 | prefix, |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 592 | table_id=0, |
| 593 | ip_table_id=0, |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 594 | is_bind=1): |
| 595 | """ |
| 596 | """ |
| 597 | return self.api( |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 598 | self.papi.mpls_ip_bind_unbind, |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 599 | {'mb_mpls_table_id': table_id, |
| 600 | 'mb_label': label, |
| 601 | 'mb_ip_table_id': ip_table_id, |
Klement Sekera | 0e3c0de | 2016-09-29 14:43:44 +0200 | [diff] [blame] | 602 | 'mb_is_bind': is_bind, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 603 | 'mb_prefix': prefix}) |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 604 | |
| 605 | def mpls_tunnel_add_del( |
| 606 | self, |
| 607 | tun_sw_if_index, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 608 | paths, |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 609 | is_add=1, |
Neale Ranns | 0f26c5a | 2017-03-01 15:12:11 -0800 | [diff] [blame] | 610 | l2_only=0, |
| 611 | is_multicast=0): |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 612 | """ |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 613 | """ |
Neale Ranns | ad422ed | 2016-11-02 14:20:04 +0000 | [diff] [blame] | 614 | return self.api( |
Ole Troan | 7e3a875 | 2016-12-05 10:27:09 +0100 | [diff] [blame] | 615 | self.papi.mpls_tunnel_add_del, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 616 | {'mt_is_add': is_add, |
| 617 | 'mt_tunnel': |
| 618 | { |
| 619 | 'mt_sw_if_index': tun_sw_if_index, |
| 620 | 'mt_l2_only': l2_only, |
| 621 | 'mt_is_multicast': is_multicast, |
| 622 | 'mt_n_paths': len(paths), |
| 623 | 'mt_paths': paths, |
| 624 | }}) |
Matus Fabian | de88675 | 2016-12-07 03:38:19 -0800 | [diff] [blame] | 625 | |
Steve Shin | 7957d6e | 2016-12-19 09:24:50 -0800 | [diff] [blame] | 626 | def input_acl_set_interface( |
| 627 | self, |
| 628 | is_add, |
| 629 | sw_if_index, |
| 630 | ip4_table_index=0xFFFFFFFF, |
| 631 | ip6_table_index=0xFFFFFFFF, |
| 632 | l2_table_index=0xFFFFFFFF): |
| 633 | """ |
| 634 | :param is_add: |
| 635 | :param sw_if_index: |
| 636 | :param ip4_table_index: (Default value = 0xFFFFFFFF) |
| 637 | :param ip6_table_index: (Default value = 0xFFFFFFFF) |
| 638 | :param l2_table_index: (Default value = 0xFFFFFFFF) |
| 639 | """ |
| 640 | |
| 641 | return self.api( |
| 642 | self.papi.input_acl_set_interface, |
Klement Sekera | 77fabdb | 2017-01-02 07:46:14 +0100 | [diff] [blame] | 643 | {'sw_if_index': sw_if_index, |
| 644 | 'ip4_table_index': ip4_table_index, |
| 645 | 'ip6_table_index': ip6_table_index, |
| 646 | 'l2_table_index': l2_table_index, |
| 647 | 'is_add': is_add}) |
| 648 | |
Andrew Yourtchenko | 815d7d5 | 2018-02-07 11:37:02 +0100 | [diff] [blame] | 649 | def output_acl_set_interface( |
| 650 | self, |
| 651 | is_add, |
| 652 | sw_if_index, |
| 653 | ip4_table_index=0xFFFFFFFF, |
| 654 | ip6_table_index=0xFFFFFFFF, |
| 655 | l2_table_index=0xFFFFFFFF): |
| 656 | """ |
| 657 | :param is_add: |
| 658 | :param sw_if_index: |
| 659 | :param ip4_table_index: (Default value = 0xFFFFFFFF) |
| 660 | :param ip6_table_index: (Default value = 0xFFFFFFFF) |
| 661 | :param l2_table_index: (Default value = 0xFFFFFFFF) |
| 662 | """ |
| 663 | |
| 664 | return self.api( |
| 665 | self.papi.output_acl_set_interface, |
| 666 | {'sw_if_index': sw_if_index, |
| 667 | 'ip4_table_index': ip4_table_index, |
| 668 | 'ip6_table_index': ip6_table_index, |
| 669 | 'l2_table_index': l2_table_index, |
| 670 | 'is_add': is_add}) |
| 671 | |
Klement Sekera | 77fabdb | 2017-01-02 07:46:14 +0100 | [diff] [blame] | 672 | def set_ipfix_exporter( |
| 673 | self, |
| 674 | collector_address, |
| 675 | src_address, |
| 676 | path_mtu, |
| 677 | template_interval, |
| 678 | vrf_id=0, |
| 679 | collector_port=4739, |
| 680 | udp_checksum=0): |
| 681 | return self.api( |
| 682 | self.papi.set_ipfix_exporter, |
| 683 | { |
| 684 | 'collector_address': collector_address, |
| 685 | 'collector_port': collector_port, |
| 686 | 'src_address': src_address, |
| 687 | 'vrf_id': vrf_id, |
| 688 | 'path_mtu': path_mtu, |
| 689 | 'template_interval': template_interval, |
| 690 | 'udp_checksum': udp_checksum, |
| 691 | }) |
Neale Ranns | fca0c24 | 2017-01-13 07:57:46 -0800 | [diff] [blame] | 692 | |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 693 | def ip_mroute_add_del(self, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 694 | table_id, |
| 695 | prefix, |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 696 | e_flags, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 697 | rpf_id, |
| 698 | paths, |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 699 | is_add=1, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 700 | is_multipath=1): |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 701 | """ |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 702 | IP Multicast Route add/del |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 703 | """ |
| 704 | return self.api( |
| 705 | self.papi.ip_mroute_add_del, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 706 | { |
| 707 | 'is_add': is_add, |
| 708 | 'is_multipath': is_multipath, |
| 709 | 'route': { |
| 710 | 'table_id': table_id, |
| 711 | 'entry_flags': e_flags, |
| 712 | 'rpf_id': rpf_id, |
| 713 | 'prefix': prefix, |
| 714 | 'n_paths': len(paths), |
| 715 | 'paths': paths, |
| 716 | } |
| 717 | }) |
| 718 | |
| 719 | def mfib_signal_dump(self): |
| 720 | return self.api(self.papi.mfib_signal_dump, {}) |
| 721 | |
| 722 | def ip_mroute_dump(self, table_id, is_ip6=False): |
| 723 | return self.api(self.papi.ip_mroute_dump, |
| 724 | {'table': { |
| 725 | 'table_id': table_id, |
| 726 | 'is_ip6': is_ip6 |
| 727 | }}) |
Neale Ranns | 32e1c01 | 2016-11-22 17:07:28 +0000 | [diff] [blame] | 728 | |
Filip Tehlar | 770e89e | 2017-01-31 10:39:16 +0100 | [diff] [blame] | 729 | def lisp_enable_disable(self, is_enabled): |
| 730 | return self.api( |
| 731 | self.papi.lisp_enable_disable, |
| 732 | { |
| 733 | 'is_en': is_enabled, |
| 734 | }) |
| 735 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 736 | def lisp_add_del_locator_set(self, |
| 737 | ls_name, |
| 738 | is_add=1): |
Filip Tehlar | 770e89e | 2017-01-31 10:39:16 +0100 | [diff] [blame] | 739 | return self.api( |
| 740 | self.papi.lisp_add_del_locator_set, |
| 741 | { |
| 742 | 'is_add': is_add, |
| 743 | 'locator_set_name': ls_name |
| 744 | }) |
| 745 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 746 | def lisp_add_del_locator(self, |
| 747 | ls_name, |
| 748 | sw_if_index, |
| 749 | priority=1, |
| 750 | weight=1, |
| 751 | is_add=1): |
Filip Tehlar | 770e89e | 2017-01-31 10:39:16 +0100 | [diff] [blame] | 752 | return self.api( |
| 753 | self.papi.lisp_add_del_locator, |
| 754 | { |
| 755 | 'is_add': is_add, |
| 756 | 'locator_set_name': ls_name, |
| 757 | 'sw_if_index': sw_if_index, |
| 758 | 'priority': priority, |
| 759 | 'weight': weight |
| 760 | }) |
| 761 | |
| 762 | def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0): |
| 763 | return self.api( |
| 764 | self.papi.lisp_locator_dump, |
| 765 | { |
| 766 | 'is_index_set': is_index_set, |
| 767 | 'ls_name': ls_name, |
| 768 | 'ls_index': ls_index, |
| 769 | }) |
| 770 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 771 | def lisp_add_del_local_eid(self, |
| 772 | ls_name, |
| 773 | eid_type, |
| 774 | eid, |
| 775 | prefix_len, |
| 776 | vni=0, |
| 777 | key_id=0, |
| 778 | key="", |
| 779 | is_add=1): |
Filip Tehlar | 770e89e | 2017-01-31 10:39:16 +0100 | [diff] [blame] | 780 | return self.api( |
| 781 | self.papi.lisp_add_del_local_eid, |
| 782 | { |
| 783 | 'locator_set_name': ls_name, |
| 784 | 'is_add': is_add, |
| 785 | 'eid_type': eid_type, |
| 786 | 'eid': eid, |
| 787 | 'prefix_len': prefix_len, |
| 788 | 'vni': vni, |
| 789 | 'key_id': key_id, |
| 790 | 'key': key |
| 791 | }) |
| 792 | |
| 793 | def lisp_eid_table_dump(self, |
| 794 | eid_set=0, |
| 795 | prefix_length=0, |
| 796 | vni=0, |
| 797 | eid_type=0, |
| 798 | eid=None, |
| 799 | filter_opt=0): |
| 800 | return self.api( |
| 801 | self.papi.lisp_eid_table_dump, |
| 802 | { |
| 803 | 'eid_set': eid_set, |
| 804 | 'prefix_length': prefix_length, |
| 805 | 'vni': vni, |
| 806 | 'eid_type': eid_type, |
| 807 | 'eid': eid, |
| 808 | 'filter': filter_opt, |
| 809 | }) |
| 810 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 811 | def lisp_add_del_remote_mapping(self, |
| 812 | eid_type, |
| 813 | eid, |
| 814 | eid_prefix_len=0, |
| 815 | vni=0, |
| 816 | rlocs=[], |
| 817 | rlocs_num=0, |
| 818 | is_src_dst=0, |
| 819 | is_add=1): |
Filip Tehlar | 770e89e | 2017-01-31 10:39:16 +0100 | [diff] [blame] | 820 | return self.api( |
| 821 | self.papi.lisp_add_del_remote_mapping, |
| 822 | { |
| 823 | 'is_add': is_add, |
| 824 | 'eid_type': eid_type, |
| 825 | 'eid': eid, |
| 826 | 'eid_len': eid_prefix_len, |
| 827 | 'rloc_num': rlocs_num, |
| 828 | 'rlocs': rlocs, |
| 829 | 'vni': vni, |
| 830 | 'is_src_dst': is_src_dst, |
| 831 | }) |
| 832 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 833 | def lisp_add_del_adjacency(self, |
| 834 | leid, |
| 835 | reid, |
| 836 | leid_len, |
| 837 | reid_len, |
| 838 | eid_type, |
| 839 | is_add=1, |
| 840 | vni=0): |
Filip Tehlar | 770e89e | 2017-01-31 10:39:16 +0100 | [diff] [blame] | 841 | return self.api( |
| 842 | self.papi.lisp_add_del_adjacency, |
| 843 | { |
| 844 | 'is_add': is_add, |
| 845 | 'vni': vni, |
| 846 | 'eid_type': eid_type, |
| 847 | 'leid': leid, |
| 848 | 'reid': reid, |
| 849 | 'leid_len': leid_len, |
| 850 | 'reid_len': reid_len, |
| 851 | }) |
| 852 | |
Hongjun Ni | 8a0a0ae | 2017-05-27 20:23:09 +0800 | [diff] [blame] | 853 | def vxlan_gpe_add_del_tunnel( |
| 854 | self, |
| 855 | src_addr, |
| 856 | dst_addr, |
| 857 | mcast_sw_if_index=0xFFFFFFFF, |
| 858 | is_add=1, |
| 859 | is_ipv6=0, |
| 860 | encap_vrf_id=0, |
| 861 | decap_vrf_id=0, |
| 862 | protocol=3, |
| 863 | vni=0): |
| 864 | """ |
| 865 | |
| 866 | :param local: |
| 867 | :param remote: |
| 868 | :param is_add: (Default value = 1) |
| 869 | :param is_ipv6: (Default value = 0) |
| 870 | :param encap_vrf_id: (Default value = 0) |
| 871 | :param decap_vrf_id: (Default value = 0) |
| 872 | :param mcast_sw_if_index: (Default value = 0xFFFFFFFF) |
| 873 | :param protocol: (Default value = 3) |
| 874 | :param vni: (Default value = 0) |
| 875 | |
| 876 | """ |
| 877 | return self.api(self.papi.vxlan_gpe_add_del_tunnel, |
| 878 | {'is_add': is_add, |
| 879 | 'is_ipv6': is_ipv6, |
| 880 | 'local': src_addr, |
| 881 | 'remote': dst_addr, |
| 882 | 'mcast_sw_if_index': mcast_sw_if_index, |
| 883 | 'encap_vrf_id': encap_vrf_id, |
| 884 | 'decap_vrf_id': decap_vrf_id, |
| 885 | 'protocol': protocol, |
| 886 | 'vni': vni}) |
Hongjun Ni | 62f9cdd | 2017-07-04 20:11:57 +0800 | [diff] [blame] | 887 | |
Neale Ranns | 79a05f5 | 2018-09-11 07:39:43 -0700 | [diff] [blame] | 888 | def vxlan_gbp_tunnel_dump(self, sw_if_index=0xffffffff): |
| 889 | return self.api(self.papi.vxlan_gbp_tunnel_dump, |
Neale Ranns | efd7bc2 | 2019-11-11 08:32:34 +0000 | [diff] [blame] | 890 | {'sw_if_index': sw_if_index}) |
Mohsin Kazmi | 61b94c6 | 2018-08-20 18:32:39 +0200 | [diff] [blame] | 891 | |
Hongjun Ni | 62f9cdd | 2017-07-04 20:11:57 +0800 | [diff] [blame] | 892 | def pppoe_add_del_session( |
| 893 | self, |
| 894 | client_ip, |
| 895 | client_mac, |
| 896 | session_id=0, |
| 897 | is_add=1, |
Hongjun Ni | 62f9cdd | 2017-07-04 20:11:57 +0800 | [diff] [blame] | 898 | decap_vrf_id=0): |
| 899 | """ |
| 900 | |
| 901 | :param is_add: (Default value = 1) |
| 902 | :param is_ipv6: (Default value = 0) |
| 903 | :param client_ip: |
| 904 | :param session_id: (Default value = 0) |
| 905 | :param client_mac: |
| 906 | :param decap_vrf_id: (Default value = 0) |
| 907 | |
| 908 | """ |
| 909 | return self.api(self.papi.pppoe_add_del_session, |
| 910 | {'is_add': is_add, |
Hongjun Ni | 62f9cdd | 2017-07-04 20:11:57 +0800 | [diff] [blame] | 911 | 'session_id': session_id, |
| 912 | 'client_ip': client_ip, |
| 913 | 'decap_vrf_id': decap_vrf_id, |
| 914 | 'client_mac': client_mac}) |
Kris Michielsen | 9107443 | 2017-06-22 13:00:20 +0200 | [diff] [blame] | 915 | |
Neale Ranns | 7c922dc | 2018-08-30 06:12:27 -0700 | [diff] [blame] | 916 | def sr_mpls_policy_add(self, bsid, weight, type, segments): |
| 917 | return self.api(self.papi.sr_mpls_policy_add, |
| 918 | {'bsid': bsid, |
| 919 | 'weight': weight, |
Jakub Grajciar | 00ec401 | 2020-01-31 10:17:29 +0100 | [diff] [blame] | 920 | 'is_spray': type, |
Neale Ranns | 7c922dc | 2018-08-30 06:12:27 -0700 | [diff] [blame] | 921 | 'n_segments': len(segments), |
| 922 | 'segments': segments}) |
| 923 | |
| 924 | def sr_mpls_policy_del(self, bsid): |
| 925 | return self.api(self.papi.sr_mpls_policy_del, |
| 926 | {'bsid': bsid}) |
| 927 | |
Neale Ranns | d91c1db | 2017-07-31 02:30:50 -0700 | [diff] [blame] | 928 | def ip_punt_police(self, |
| 929 | policer_index, |
| 930 | is_ip6=0, |
| 931 | is_add=1): |
| 932 | return self.api(self.papi.ip_punt_police, |
| 933 | {'policer_index': policer_index, |
| 934 | 'is_add': is_add, |
| 935 | 'is_ip6': is_ip6}) |
| 936 | |
| 937 | def ip_punt_redirect(self, |
| 938 | rx_sw_if_index, |
| 939 | tx_sw_if_index, |
Pavel Kotucek | 609e121 | 2018-11-27 09:59:44 +0100 | [diff] [blame] | 940 | address, |
Neale Ranns | d91c1db | 2017-07-31 02:30:50 -0700 | [diff] [blame] | 941 | is_add=1): |
| 942 | return self.api(self.papi.ip_punt_redirect, |
Pavel Kotucek | 609e121 | 2018-11-27 09:59:44 +0100 | [diff] [blame] | 943 | {'punt': {'rx_sw_if_index': rx_sw_if_index, |
| 944 | 'tx_sw_if_index': tx_sw_if_index, |
| 945 | 'nh': address}, |
| 946 | 'is_add': is_add}) |
| 947 | |
| 948 | def ip_punt_redirect_dump(self, sw_if_index, is_ipv6=0): |
| 949 | return self.api(self.papi.ip_punt_redirect_dump, |
| 950 | {'sw_if_index': sw_if_index, |
| 951 | 'is_ipv6': is_ipv6}) |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 952 | |
| 953 | def bier_table_add_del(self, |
| 954 | bti, |
| 955 | mpls_label, |
| 956 | is_add=1): |
| 957 | """ BIER Table add/del """ |
| 958 | return self.api( |
| 959 | self.papi.bier_table_add_del, |
| 960 | {'bt_tbl_id': {"bt_set": bti.set_id, |
| 961 | "bt_sub_domain": bti.sub_domain_id, |
| 962 | "bt_hdr_len_id": bti.hdr_len_id}, |
| 963 | 'bt_label': mpls_label, |
| 964 | 'bt_is_add': is_add}) |
| 965 | |
| 966 | def bier_table_dump(self): |
| 967 | return self.api(self.papi.bier_table_dump, {}) |
| 968 | |
| 969 | def bier_route_add_del(self, |
| 970 | bti, |
| 971 | bp, |
Neale Ranns | 9128637 | 2017-12-05 13:24:04 -0800 | [diff] [blame] | 972 | paths, |
Neale Ranns | ef90ed0 | 2018-09-13 08:45:12 -0700 | [diff] [blame] | 973 | is_add=1, |
| 974 | is_replace=0): |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 975 | """ BIER Route add/del """ |
| 976 | return self.api( |
| 977 | self.papi.bier_route_add_del, |
Neale Ranns | 097fa66 | 2018-05-01 05:17:55 -0700 | [diff] [blame] | 978 | { |
| 979 | 'br_route': { |
| 980 | 'br_tbl_id': {"bt_set": bti.set_id, |
| 981 | "bt_sub_domain": bti.sub_domain_id, |
| 982 | "bt_hdr_len_id": bti.hdr_len_id}, |
| 983 | 'br_bp': bp, |
| 984 | 'br_n_paths': len(paths), |
| 985 | 'br_paths': paths, |
| 986 | }, |
| 987 | 'br_is_add': is_add, |
| 988 | 'br_is_replace': is_replace |
| 989 | }) |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 990 | |
| 991 | def bier_route_dump(self, bti): |
| 992 | return self.api( |
| 993 | self.papi.bier_route_dump, |
| 994 | {'br_tbl_id': {"bt_set": bti.set_id, |
| 995 | "bt_sub_domain": bti.sub_domain_id, |
| 996 | "bt_hdr_len_id": bti.hdr_len_id}}) |
| 997 | |
| 998 | def bier_imp_add(self, |
| 999 | bti, |
| 1000 | src, |
| 1001 | ibytes, |
| 1002 | is_add=1): |
| 1003 | """ BIER Imposition Add """ |
| 1004 | return self.api( |
| 1005 | self.papi.bier_imp_add, |
| 1006 | {'bi_tbl_id': {"bt_set": bti.set_id, |
| 1007 | "bt_sub_domain": bti.sub_domain_id, |
| 1008 | "bt_hdr_len_id": bti.hdr_len_id}, |
| 1009 | 'bi_src': src, |
| 1010 | 'bi_n_bytes': len(ibytes), |
| 1011 | 'bi_bytes': ibytes}) |
| 1012 | |
| 1013 | def bier_imp_del(self, bi_index): |
| 1014 | """ BIER Imposition del """ |
| 1015 | return self.api( |
| 1016 | self.papi.bier_imp_del, |
| 1017 | {'bi_index': bi_index}) |
| 1018 | |
| 1019 | def bier_imp_dump(self): |
| 1020 | return self.api(self.papi.bier_imp_dump, {}) |
| 1021 | |
| 1022 | def bier_disp_table_add_del(self, |
| 1023 | bdti, |
| 1024 | is_add=1): |
| 1025 | """ BIER Disposition Table add/del """ |
| 1026 | return self.api( |
| 1027 | self.papi.bier_disp_table_add_del, |
| 1028 | {'bdt_tbl_id': bdti, |
| 1029 | 'bdt_is_add': is_add}) |
| 1030 | |
| 1031 | def bier_disp_table_dump(self): |
| 1032 | return self.api(self.papi.bier_disp_table_dump, {}) |
| 1033 | |
| 1034 | def bier_disp_entry_add_del(self, |
| 1035 | bdti, |
| 1036 | bp, |
| 1037 | payload_proto, |
Neale Ranns | f051072 | 2018-01-31 11:35:41 -0800 | [diff] [blame] | 1038 | next_hop_afi, |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 1039 | next_hop, |
| 1040 | next_hop_tbl_id=0, |
| 1041 | next_hop_rpf_id=~0, |
| 1042 | next_hop_is_ip4=1, |
| 1043 | is_add=1): |
| 1044 | """ BIER Route add/del """ |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 1045 | lstack = [] |
| 1046 | while (len(lstack) < 16): |
| 1047 | lstack.append({}) |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 1048 | return self.api( |
| 1049 | self.papi.bier_disp_entry_add_del, |
| 1050 | {'bde_tbl_id': bdti, |
| 1051 | 'bde_bp': bp, |
| 1052 | 'bde_payload_proto': payload_proto, |
| 1053 | 'bde_n_paths': 1, |
Paul Vinciguerra | 79a32a4 | 2019-07-11 19:09:30 -0400 | [diff] [blame] | 1054 | 'bde_paths': [{'table_id': next_hop_tbl_id, |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 1055 | 'rpf_id': next_hop_rpf_id, |
| 1056 | 'n_labels': 0, |
Neale Ranns | 31ed744 | 2018-02-23 05:29:09 -0800 | [diff] [blame] | 1057 | 'label_stack': lstack}], |
Neale Ranns | d792d9c | 2017-10-21 10:53:20 -0700 | [diff] [blame] | 1058 | 'bde_is_add': is_add}) |
| 1059 | |
| 1060 | def bier_disp_entry_dump(self, bdti): |
| 1061 | return self.api( |
| 1062 | self.papi.bier_disp_entry_dump, |
| 1063 | {'bde_tbl_id': bdti}) |
Gabriel Ganne | 8527f12 | 2017-10-02 11:41:24 +0200 | [diff] [blame] | 1064 | |
Florin Coras | 3ea6ce2 | 2017-12-11 09:09:05 -0800 | [diff] [blame] | 1065 | def session_enable_disable(self, is_enabled): |
| 1066 | return self.api( |
| 1067 | self.papi.session_enable_disable, |
| 1068 | {'is_enable': is_enabled}) |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1069 | |
| 1070 | def ipsec_spd_add_del(self, spd_id, is_add=1): |
| 1071 | """ SPD add/del - Wrapper to add or del ipsec SPD |
| 1072 | Sample CLI : 'ipsec spd add 1' |
| 1073 | |
| 1074 | :param spd_id - SPD ID to be created in the vpp . mandatory |
| 1075 | :param is_add - create (1) or delete(0) SPD (Default 1 - add) . |
| 1076 | optional |
| 1077 | :returns: reply from the API |
| 1078 | """ |
| 1079 | return self.api( |
| 1080 | self.papi.ipsec_spd_add_del, { |
| 1081 | 'spd_id': spd_id, 'is_add': is_add}) |
| 1082 | |
Neale Ranns | 311124e | 2019-01-24 04:52:25 -0800 | [diff] [blame] | 1083 | def ipsec_spds_dump(self): |
| 1084 | return self.api(self.papi.ipsec_spds_dump, {}) |
| 1085 | |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1086 | def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1): |
| 1087 | """ IPSEC interface SPD add/del - \ |
| 1088 | Wrapper to associate/disassociate SPD to interface in VPP |
| 1089 | Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1' |
| 1090 | |
| 1091 | :param spd_id - SPD ID to associate with the interface . mandatory |
| 1092 | :param sw_if_index - Interface Index which needs to ipsec \ |
| 1093 | association mandatory |
| 1094 | :param is_add - add(1) or del(0) association with interface \ |
| 1095 | (Default 1 - add) . optional |
| 1096 | :returns: reply from the API |
| 1097 | """ |
| 1098 | return self.api( |
Klement Sekera | 4b089f2 | 2018-04-17 18:04:57 +0200 | [diff] [blame] | 1099 | self.papi.ipsec_interface_add_del_spd, |
| 1100 | {'spd_id': spd_id, 'sw_if_index': sw_if_index, 'is_add': is_add}) |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1101 | |
Neale Ranns | 311124e | 2019-01-24 04:52:25 -0800 | [diff] [blame] | 1102 | def ipsec_spd_interface_dump(self, spd_index=None): |
| 1103 | return self.api(self.papi.ipsec_spd_interface_dump, |
| 1104 | {'spd_index': spd_index if spd_index else 0, |
| 1105 | 'spd_index_valid': 1 if spd_index else 0}) |
| 1106 | |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1107 | def ipsec_sad_entry_add_del(self, |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1108 | sad_id, |
| 1109 | spi, |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1110 | integrity_algorithm, |
| 1111 | integrity_key, |
| 1112 | crypto_algorithm, |
| 1113 | crypto_key, |
| 1114 | protocol, |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1115 | tunnel_src_address='', |
| 1116 | tunnel_dst_address='', |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1117 | flags=0, |
Neale Ranns | 80f6fd5 | 2019-04-16 02:41:34 +0000 | [diff] [blame] | 1118 | salt=0, |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1119 | is_add=1): |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1120 | """ IPSEC SA add/del |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1121 | :param sad_id: security association ID |
| 1122 | :param spi: security param index of the SA in decimal |
| 1123 | :param integrity_algorithm: |
| 1124 | :param integrity_key: |
| 1125 | :param crypto_algorithm: |
| 1126 | :param crypto_key: |
| 1127 | :param protocol: AH(0) or ESP(1) protocol |
| 1128 | :param tunnel_src_address: tunnel mode outer src address |
| 1129 | :param tunnel_dst_address: tunnel mode outer dst address |
| 1130 | :param is_add: |
| 1131 | :param is_tunnel: |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1132 | :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of |
| 1133 | crypto and ipsec algorithms |
| 1134 | """ |
| 1135 | return self.api( |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1136 | self.papi.ipsec_sad_entry_add_del, |
| 1137 | { |
| 1138 | 'is_add': is_add, |
| 1139 | 'entry': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1140 | { |
| 1141 | 'sad_id': sad_id, |
| 1142 | 'spi': spi, |
| 1143 | 'tunnel_src': tunnel_src_address, |
| 1144 | 'tunnel_dst': tunnel_dst_address, |
| 1145 | 'protocol': protocol, |
| 1146 | 'integrity_algorithm': integrity_algorithm, |
| 1147 | 'integrity_key': { |
| 1148 | 'length': len(integrity_key), |
| 1149 | 'data': integrity_key, |
| 1150 | }, |
| 1151 | 'crypto_algorithm': crypto_algorithm, |
| 1152 | 'crypto_key': { |
| 1153 | 'length': len(crypto_key), |
| 1154 | 'data': crypto_key, |
| 1155 | }, |
| 1156 | 'flags': flags, |
Neale Ranns | 80f6fd5 | 2019-04-16 02:41:34 +0000 | [diff] [blame] | 1157 | 'salt': salt, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1158 | } |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1159 | }) |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1160 | |
Neale Ranns | 311124e | 2019-01-24 04:52:25 -0800 | [diff] [blame] | 1161 | def ipsec_sa_dump(self, sa_id=None): |
| 1162 | return self.api(self.papi.ipsec_sa_dump, |
| 1163 | {'sa_id': sa_id if sa_id else 0xffffffff}) |
| 1164 | |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1165 | def ipsec_spd_entry_add_del(self, |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1166 | spd_id, |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1167 | sa_id, |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1168 | local_address_start, |
| 1169 | local_address_stop, |
| 1170 | remote_address_start, |
| 1171 | remote_address_stop, |
| 1172 | local_port_start=0, |
| 1173 | local_port_stop=65535, |
| 1174 | remote_port_start=0, |
| 1175 | remote_port_stop=65535, |
| 1176 | protocol=0, |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1177 | policy=0, |
| 1178 | priority=100, |
| 1179 | is_outbound=1, |
| 1180 | is_add=1, |
Klement Sekera | 611864f | 2018-09-26 11:19:00 +0200 | [diff] [blame] | 1181 | is_ipv6=0, |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1182 | is_ip_any=0): |
| 1183 | """ IPSEC policy SPD add/del - |
| 1184 | Wrapper to configure ipsec SPD policy entries in VPP |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1185 | :param spd_id: SPD ID for the policy |
| 1186 | :param local_address_start: local-ip-range start address |
| 1187 | :param local_address_stop : local-ip-range stop address |
| 1188 | :param remote_address_start: remote-ip-range start address |
| 1189 | :param remote_address_stop : remote-ip-range stop address |
| 1190 | :param local_port_start: (Default value = 0) |
| 1191 | :param local_port_stop: (Default value = 65535) |
| 1192 | :param remote_port_start: (Default value = 0) |
| 1193 | :param remote_port_stop: (Default value = 65535) |
| 1194 | :param protocol: Any(0), AH(51) & ESP(50) protocol (Default value = 0) |
| 1195 | :param sa_id: Security Association ID for mapping it to SPD |
| 1196 | :param policy: bypass(0), discard(1), resolve(2) or protect(3) action |
| 1197 | (Default value = 0) |
| 1198 | :param priority: value for the spd action (Default value = 100) |
| 1199 | :param is_outbound: flag for inbound(0) or outbound(1) |
| 1200 | (Default value = 1) |
| 1201 | :param is_add: (Default value = 1) |
“mystarrocks” | 23f0c45 | 2017-12-11 07:11:51 -0800 | [diff] [blame] | 1202 | """ |
| 1203 | return self.api( |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1204 | self.papi.ipsec_spd_entry_add_del, |
| 1205 | { |
| 1206 | 'is_add': is_add, |
| 1207 | 'entry': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1208 | { |
| 1209 | 'spd_id': spd_id, |
| 1210 | 'sa_id': sa_id, |
| 1211 | 'local_address_start': local_address_start, |
| 1212 | 'local_address_stop': local_address_stop, |
| 1213 | 'remote_address_start': remote_address_start, |
| 1214 | 'remote_address_stop': remote_address_stop, |
| 1215 | 'local_port_start': local_port_start, |
| 1216 | 'local_port_stop': local_port_stop, |
| 1217 | 'remote_port_start': remote_port_start, |
| 1218 | 'remote_port_stop': remote_port_stop, |
| 1219 | 'protocol': protocol, |
| 1220 | 'policy': policy, |
| 1221 | 'priority': priority, |
| 1222 | 'is_outbound': is_outbound, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1223 | } |
Neale Ranns | 17dcec0 | 2019-01-09 21:22:20 -0800 | [diff] [blame] | 1224 | }) |
Florin Coras | b795bd0 | 2017-12-14 11:30:48 -0800 | [diff] [blame] | 1225 | |
Neale Ranns | 311124e | 2019-01-24 04:52:25 -0800 | [diff] [blame] | 1226 | def ipsec_spd_dump(self, spd_id, sa_id=0xffffffff): |
| 1227 | return self.api(self.papi.ipsec_spd_dump, |
| 1228 | {'spd_id': spd_id, |
| 1229 | 'sa_id': sa_id}) |
| 1230 | |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1231 | def ipsec_tunnel_if_add_del(self, local_ip, remote_ip, local_spi, |
| 1232 | remote_spi, crypto_alg, local_crypto_key, |
| 1233 | remote_crypto_key, integ_alg, local_integ_key, |
Neale Ranns | 80f6fd5 | 2019-04-16 02:41:34 +0000 | [diff] [blame] | 1234 | remote_integ_key, is_add=1, esn=0, salt=0, |
Neale Ranns | a6bee0a | 2019-06-14 01:13:25 -0700 | [diff] [blame] | 1235 | anti_replay=1, renumber=0, |
Neale Ranns | 12989b5 | 2019-09-26 16:20:19 +0000 | [diff] [blame] | 1236 | udp_encap=0, show_instance=0xffffffff): |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1237 | return self.api( |
| 1238 | self.papi.ipsec_tunnel_if_add_del, |
Kingwel Xie | 1ba5bc8 | 2019-03-20 07:21:58 -0400 | [diff] [blame] | 1239 | { |
| 1240 | 'local_ip': local_ip, |
| 1241 | 'remote_ip': remote_ip, |
| 1242 | 'local_spi': local_spi, |
| 1243 | 'remote_spi': remote_spi, |
| 1244 | 'crypto_alg': crypto_alg, |
| 1245 | 'local_crypto_key_len': len(local_crypto_key), |
| 1246 | 'local_crypto_key': local_crypto_key, |
| 1247 | 'remote_crypto_key_len': len(remote_crypto_key), |
| 1248 | 'remote_crypto_key': remote_crypto_key, |
| 1249 | 'integ_alg': integ_alg, |
| 1250 | 'local_integ_key_len': len(local_integ_key), |
| 1251 | 'local_integ_key': local_integ_key, |
| 1252 | 'remote_integ_key_len': len(remote_integ_key), |
| 1253 | 'remote_integ_key': remote_integ_key, |
| 1254 | 'is_add': is_add, |
| 1255 | 'esn': esn, |
| 1256 | 'anti_replay': anti_replay, |
| 1257 | 'renumber': renumber, |
Neale Ranns | 80f6fd5 | 2019-04-16 02:41:34 +0000 | [diff] [blame] | 1258 | 'show_instance': show_instance, |
Neale Ranns | a6bee0a | 2019-06-14 01:13:25 -0700 | [diff] [blame] | 1259 | 'udp_encap': udp_encap, |
Neale Ranns | 80f6fd5 | 2019-04-16 02:41:34 +0000 | [diff] [blame] | 1260 | 'salt': salt |
Kingwel Xie | 1ba5bc8 | 2019-03-20 07:21:58 -0400 | [diff] [blame] | 1261 | }) |
Klement Sekera | 31da2e3 | 2018-06-24 22:49:55 +0200 | [diff] [blame] | 1262 | |
Klement Sekera | b4d3053 | 2018-11-08 13:00:02 +0100 | [diff] [blame] | 1263 | def ipsec_select_backend(self, protocol, index): |
| 1264 | return self.api(self.papi.ipsec_select_backend, |
| 1265 | {'protocol': protocol, 'index': index}) |
| 1266 | |
| 1267 | def ipsec_backend_dump(self): |
| 1268 | return self.api(self.papi.ipsec_backend_dump, {}) |
| 1269 | |
Ole Troan | e1ade68 | 2019-03-04 23:55:43 +0100 | [diff] [blame] | 1270 | def app_namespace_add_del(self, |
| 1271 | namespace_id, |
| 1272 | ip4_fib_id=0, |
| 1273 | ip6_fib_id=0, |
| 1274 | sw_if_index=0xFFFFFFFF, |
| 1275 | secret=0): |
Florin Coras | b795bd0 | 2017-12-14 11:30:48 -0800 | [diff] [blame] | 1276 | return self.api( |
| 1277 | self.papi.app_namespace_add_del, |
| 1278 | {'secret': secret, |
| 1279 | 'sw_if_index': sw_if_index, |
| 1280 | 'ip4_fib_id': ip4_fib_id, |
| 1281 | 'ip6_fib_id': ip6_fib_id, |
Jakub Grajciar | b4e5e50 | 2020-01-31 09:35:29 +0100 | [diff] [blame] | 1282 | 'namespace_id': namespace_id}) |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 1283 | |
Neale Ranns | 50f0ac0 | 2019-05-15 02:13:37 -0700 | [diff] [blame] | 1284 | def punt_socket_register(self, reg, pathname, |
| 1285 | header_version=1): |
Pavel Kotucek | e88865d | 2018-11-28 07:42:11 +0100 | [diff] [blame] | 1286 | """ Register punt socket """ |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 1287 | return self.api(self.papi.punt_socket_register, |
Pavel Kotucek | e88865d | 2018-11-28 07:42:11 +0100 | [diff] [blame] | 1288 | {'header_version': header_version, |
Neale Ranns | 50f0ac0 | 2019-05-15 02:13:37 -0700 | [diff] [blame] | 1289 | 'punt': reg, |
Pavel Kotucek | e88865d | 2018-11-28 07:42:11 +0100 | [diff] [blame] | 1290 | 'pathname': pathname}) |
| 1291 | |
Neale Ranns | 50f0ac0 | 2019-05-15 02:13:37 -0700 | [diff] [blame] | 1292 | def punt_socket_deregister(self, reg): |
Pavel Kotucek | e88865d | 2018-11-28 07:42:11 +0100 | [diff] [blame] | 1293 | """ Unregister punt socket """ |
| 1294 | return self.api(self.papi.punt_socket_deregister, |
Neale Ranns | 50f0ac0 | 2019-05-15 02:13:37 -0700 | [diff] [blame] | 1295 | {'punt': reg}) |
Klement Sekera | 75e7d13 | 2017-09-20 08:26:30 +0200 | [diff] [blame] | 1296 | |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1297 | def gbp_endpoint_add(self, sw_if_index, ips, mac, sclass, flags, |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1298 | tun_src, tun_dst): |
Neale Ranns | c0a9314 | 2018-09-05 15:42:26 -0700 | [diff] [blame] | 1299 | """ GBP endpoint Add """ |
| 1300 | return self.api(self.papi.gbp_endpoint_add, |
| 1301 | {'endpoint': { |
| 1302 | 'sw_if_index': sw_if_index, |
| 1303 | 'ips': ips, |
| 1304 | 'n_ips': len(ips), |
| 1305 | 'mac': mac, |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1306 | 'sclass': sclass, |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1307 | 'flags': flags, |
| 1308 | 'tun': { |
| 1309 | 'src': tun_src, |
| 1310 | 'dst': tun_dst, |
| 1311 | }}}) |
Neale Ranns | c0a9314 | 2018-09-05 15:42:26 -0700 | [diff] [blame] | 1312 | |
| 1313 | def gbp_endpoint_del(self, handle): |
| 1314 | """ GBP endpoint Del """ |
| 1315 | return self.api(self.papi.gbp_endpoint_del, |
| 1316 | {'handle': handle}) |
Neale Ranns | bc27d1b | 2018-02-05 01:13:38 -0800 | [diff] [blame] | 1317 | |
| 1318 | def gbp_endpoint_dump(self): |
| 1319 | """ GBP endpoint Dump """ |
Neale Ranns | efd7bc2 | 2019-11-11 08:32:34 +0000 | [diff] [blame] | 1320 | return self.api(self.papi.gbp_endpoint_dump, {}) |
Neale Ranns | bc27d1b | 2018-02-05 01:13:38 -0800 | [diff] [blame] | 1321 | |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1322 | def gbp_endpoint_group_add(self, vnid, sclass, bd, |
Neale Ranns | 32f6d8e | 2019-03-05 04:22:08 -0800 | [diff] [blame] | 1323 | rd, uplink_sw_if_index, |
| 1324 | retention): |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1325 | """ GBP endpoint group Add """ |
| 1326 | return self.api(self.papi.gbp_endpoint_group_add, |
| 1327 | {'epg': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1328 | { |
| 1329 | 'uplink_sw_if_index': uplink_sw_if_index, |
| 1330 | 'bd_id': bd, |
| 1331 | 'rd_id': rd, |
| 1332 | 'vnid': vnid, |
| 1333 | 'sclass': sclass, |
| 1334 | 'retention': retention |
| 1335 | }}) |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1336 | |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1337 | def gbp_endpoint_group_del(self, sclass): |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1338 | """ GBP endpoint group Del """ |
| 1339 | return self.api(self.papi.gbp_endpoint_group_del, |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1340 | {'sclass': sclass}) |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1341 | |
Neale Ranns | 160c923 | 2019-06-19 06:25:56 -0700 | [diff] [blame] | 1342 | def gbp_bridge_domain_add(self, bd_id, rd_id, flags, |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1343 | bvi_sw_if_index, |
Neale Ranns | 879d11c | 2019-01-21 23:34:18 -0800 | [diff] [blame] | 1344 | uu_fwd_sw_if_index, |
| 1345 | bm_flood_sw_if_index): |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1346 | """ GBP bridge-domain Add """ |
| 1347 | return self.api(self.papi.gbp_bridge_domain_add, |
| 1348 | {'bd': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1349 | { |
| 1350 | 'flags': flags, |
| 1351 | 'bvi_sw_if_index': bvi_sw_if_index, |
| 1352 | 'uu_fwd_sw_if_index': uu_fwd_sw_if_index, |
| 1353 | 'bm_flood_sw_if_index': bm_flood_sw_if_index, |
Neale Ranns | 160c923 | 2019-06-19 06:25:56 -0700 | [diff] [blame] | 1354 | 'bd_id': bd_id, |
| 1355 | 'rd_id': rd_id |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1356 | }}) |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1357 | |
| 1358 | def gbp_bridge_domain_del(self, bd_id): |
| 1359 | """ GBP bridge-domain Del """ |
| 1360 | return self.api(self.papi.gbp_bridge_domain_del, |
| 1361 | {'bd_id': bd_id}) |
| 1362 | |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1363 | def gbp_route_domain_add(self, rd_id, |
Neale Ranns | 160c923 | 2019-06-19 06:25:56 -0700 | [diff] [blame] | 1364 | scope, |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1365 | ip4_table_id, |
| 1366 | ip6_table_id, |
| 1367 | ip4_uu_sw_if_index, |
| 1368 | ip6_uu_sw_if_index): |
| 1369 | """ GBP route-domain Add """ |
| 1370 | return self.api(self.papi.gbp_route_domain_add, |
| 1371 | {'rd': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1372 | { |
Neale Ranns | 160c923 | 2019-06-19 06:25:56 -0700 | [diff] [blame] | 1373 | 'scope': scope, |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1374 | 'ip4_table_id': ip4_table_id, |
| 1375 | 'ip6_table_id': ip6_table_id, |
| 1376 | 'ip4_uu_sw_if_index': ip4_uu_sw_if_index, |
| 1377 | 'ip6_uu_sw_if_index': ip6_uu_sw_if_index, |
| 1378 | 'rd_id': rd_id |
| 1379 | }}) |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1380 | |
| 1381 | def gbp_route_domain_del(self, rd_id): |
| 1382 | """ GBP route-domain Del """ |
| 1383 | return self.api(self.papi.gbp_route_domain_del, |
| 1384 | {'rd_id': rd_id}) |
| 1385 | |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1386 | def gbp_recirc_add_del(self, is_add, sw_if_index, sclass, is_ext): |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1387 | """ GBP recirc Add/Del """ |
| 1388 | return self.api(self.papi.gbp_recirc_add_del, |
| 1389 | {'is_add': is_add, |
| 1390 | 'recirc': { |
| 1391 | 'is_ext': is_ext, |
| 1392 | 'sw_if_index': sw_if_index, |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1393 | 'sclass': sclass}}) |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1394 | |
| 1395 | def gbp_recirc_dump(self): |
| 1396 | """ GBP recirc Dump """ |
| 1397 | return self.api(self.papi.gbp_recirc_dump, {}) |
| 1398 | |
Benoît Ganne | ba6abfa | 2019-07-01 17:10:41 +0200 | [diff] [blame] | 1399 | def gbp_ext_itf_add_del(self, is_add, sw_if_index, bd_id, rd_id, flags): |
Neale Ranns | b6a4795 | 2018-11-21 05:44:35 -0800 | [diff] [blame] | 1400 | """ GBP recirc Add/Del """ |
| 1401 | return self.api(self.papi.gbp_ext_itf_add_del, |
| 1402 | {'is_add': is_add, |
| 1403 | 'ext_itf': { |
| 1404 | 'sw_if_index': sw_if_index, |
| 1405 | 'bd_id': bd_id, |
Benoît Ganne | ba6abfa | 2019-07-01 17:10:41 +0200 | [diff] [blame] | 1406 | 'rd_id': rd_id, |
| 1407 | 'flags': flags}}) |
Neale Ranns | b6a4795 | 2018-11-21 05:44:35 -0800 | [diff] [blame] | 1408 | |
| 1409 | def gbp_ext_itf_dump(self): |
| 1410 | """ GBP recirc Dump """ |
| 1411 | return self.api(self.papi.gbp_ext_itf_dump, {}) |
| 1412 | |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1413 | def gbp_subnet_add_del(self, is_add, rd_id, |
| 1414 | prefix, type, |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1415 | sw_if_index=0xffffffff, |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1416 | sclass=0xffff): |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1417 | """ GBP Subnet Add/Del """ |
| 1418 | return self.api(self.papi.gbp_subnet_add_del, |
| 1419 | {'is_add': is_add, |
| 1420 | 'subnet': { |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1421 | 'type': type, |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1422 | 'sw_if_index': sw_if_index, |
Neale Ranns | 4ba6772 | 2019-02-28 11:11:39 +0000 | [diff] [blame] | 1423 | 'sclass': sclass, |
Neale Ranns | c0a9314 | 2018-09-05 15:42:26 -0700 | [diff] [blame] | 1424 | 'prefix': prefix, |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1425 | 'rd_id': rd_id}}) |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1426 | |
| 1427 | def gbp_subnet_dump(self): |
| 1428 | """ GBP Subnet Dump """ |
Neale Ranns | efd7bc2 | 2019-11-11 08:32:34 +0000 | [diff] [blame] | 1429 | return self.api(self.papi.gbp_subnet_dump, {}) |
Neale Ranns | 25b0494 | 2018-04-04 09:34:50 -0700 | [diff] [blame] | 1430 | |
Neale Ranns | bc27d1b | 2018-02-05 01:13:38 -0800 | [diff] [blame] | 1431 | def gbp_contract_dump(self): |
| 1432 | """ GBP contract Dump """ |
| 1433 | return self.api(self.papi.gbp_contract_dump, {}) |
Ole Troan | 6ee4051 | 2018-02-12 18:14:39 +0100 | [diff] [blame] | 1434 | |
Neale Ranns | 8da9fc6 | 2019-03-04 14:08:11 -0800 | [diff] [blame] | 1435 | def gbp_vxlan_tunnel_add(self, vni, bd_rd_id, mode, src): |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1436 | """ GBP VXLAN tunnel add """ |
| 1437 | return self.api(self.papi.gbp_vxlan_tunnel_add, |
| 1438 | { |
| 1439 | 'tunnel': { |
| 1440 | 'vni': vni, |
| 1441 | 'mode': mode, |
Neale Ranns | 8da9fc6 | 2019-03-04 14:08:11 -0800 | [diff] [blame] | 1442 | 'bd_rd_id': bd_rd_id, |
| 1443 | 'src': src |
Neale Ranns | 93cc3ee | 2018-10-10 07:22:51 -0700 | [diff] [blame] | 1444 | } |
| 1445 | }) |
| 1446 | |
| 1447 | def gbp_vxlan_tunnel_del(self, vni): |
| 1448 | """ GBP VXLAN tunnel del """ |
| 1449 | return self.api(self.papi.gbp_vxlan_tunnel_del, |
| 1450 | { |
| 1451 | 'vni': vni, |
| 1452 | }) |
| 1453 | |
| 1454 | def gbp_vxlan_tunnel_dump(self): |
| 1455 | """ GBP VXLAN tunnel add/del """ |
| 1456 | return self.api(self.papi.gbp_vxlan_tunnel_dump, {}) |
| 1457 | |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 1458 | def igmp_enable_disable(self, sw_if_index, enable, host): |
| 1459 | """ Enable/disable IGMP on a given interface """ |
| 1460 | return self.api(self.papi.igmp_enable_disable, |
| 1461 | {'enable': enable, |
| 1462 | 'mode': host, |
| 1463 | 'sw_if_index': sw_if_index}) |
| 1464 | |
Jakub Grajciar | 97748ca | 2018-10-04 11:05:35 +0200 | [diff] [blame] | 1465 | def igmp_proxy_device_add_del(self, vrf_id, sw_if_index, add): |
| 1466 | """ Add/del IGMP proxy device """ |
| 1467 | return self.api(self.papi.igmp_proxy_device_add_del, |
| 1468 | {'vrf_id': vrf_id, 'sw_if_index': sw_if_index, |
| 1469 | 'add': add}) |
| 1470 | |
| 1471 | def igmp_proxy_device_add_del_interface(self, vrf_id, sw_if_index, add): |
| 1472 | """ Add/del interface to/from IGMP proxy device """ |
| 1473 | return self.api(self.papi.igmp_proxy_device_add_del_interface, |
| 1474 | {'vrf_id': vrf_id, 'sw_if_index': sw_if_index, |
| 1475 | 'add': add}) |
| 1476 | |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 1477 | def igmp_listen(self, filter, sw_if_index, saddrs, gaddr): |
Jakub Grajciar | 7b867a8 | 2017-12-08 16:28:42 +0100 | [diff] [blame] | 1478 | """ Listen for new (S,G) on specified interface |
| 1479 | |
| 1480 | :param enable: add/del |
| 1481 | :param sw_if_index: interface sw index |
| 1482 | :param saddr: source ip4 addr |
| 1483 | :param gaddr: group ip4 addr |
| 1484 | """ |
| 1485 | return self.api(self.papi.igmp_listen, |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 1486 | { |
| 1487 | 'group': |
Ole Troan | 9a47537 | 2019-03-05 16:58:24 +0100 | [diff] [blame] | 1488 | { |
| 1489 | 'filter': filter, |
| 1490 | 'sw_if_index': sw_if_index, |
| 1491 | 'n_srcs': len(saddrs), |
| 1492 | 'saddrs': saddrs, |
| 1493 | 'gaddr': gaddr |
| 1494 | } |
Neale Ranns | 947ea62 | 2018-06-07 23:48:20 -0700 | [diff] [blame] | 1495 | }) |
Jakub Grajciar | 7b867a8 | 2017-12-08 16:28:42 +0100 | [diff] [blame] | 1496 | |
Jakub Grajciar | 7b867a8 | 2017-12-08 16:28:42 +0100 | [diff] [blame] | 1497 | def igmp_clear_interface(self, sw_if_index): |
| 1498 | """ Remove all (S,G)s from specified interface |
| 1499 | doesn't send IGMP report! |
| 1500 | """ |
| 1501 | return self.api( |
| 1502 | self.papi.igmp_clear_interface, { |
| 1503 | 'sw_if_index': sw_if_index}) |
| 1504 | |
| 1505 | def want_igmp_events(self, enable=1): |
| 1506 | return self.api(self.papi.want_igmp_events, {'enable': enable, |
| 1507 | 'pid': os.getpid()}) |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1508 | |
| 1509 | def bond_create( |
| 1510 | self, |
| 1511 | mode, |
| 1512 | lb, |
Zhiyong Yang | 751e3f3 | 2019-06-26 05:49:14 -0400 | [diff] [blame] | 1513 | numa_only, |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1514 | use_custom_mac, |
Alexander Chernavin | ad9d528 | 2018-12-13 09:08:09 -0500 | [diff] [blame] | 1515 | mac_address='', |
| 1516 | interface_id=0xFFFFFFFF): |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1517 | """ |
| 1518 | :param mode: mode |
| 1519 | :param lb: load balance |
Zhiyong Yang | 751e3f3 | 2019-06-26 05:49:14 -0400 | [diff] [blame] | 1520 | :param numa_only: tx on local numa node for lacp mode |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1521 | :param use_custom_mac: use custom mac |
| 1522 | :param mac_address: mac address |
Alexander Chernavin | ad9d528 | 2018-12-13 09:08:09 -0500 | [diff] [blame] | 1523 | :param interface_id: custom interface ID |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1524 | """ |
| 1525 | return self.api( |
| 1526 | self.papi.bond_create, |
| 1527 | {'mode': mode, |
| 1528 | 'lb': lb, |
Zhiyong Yang | 751e3f3 | 2019-06-26 05:49:14 -0400 | [diff] [blame] | 1529 | 'numa_only': numa_only, |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1530 | 'use_custom_mac': use_custom_mac, |
Alexander Chernavin | ad9d528 | 2018-12-13 09:08:09 -0500 | [diff] [blame] | 1531 | 'mac_address': mac_address, |
| 1532 | 'id': interface_id |
Steven | 9cd2d7a | 2017-12-20 12:43:01 -0800 | [diff] [blame] | 1533 | }) |
| 1534 | |
Neale Ranns | 17ff3c1 | 2018-07-04 10:24:24 -0700 | [diff] [blame] | 1535 | def pipe_delete(self, parent_sw_if_index): |
| 1536 | return self.api(self.papi.pipe_delete, |
| 1537 | {'parent_sw_if_index': parent_sw_if_index}) |
| 1538 | |
Neale Ranns | d1e68ab | 2018-10-01 01:42:13 -0700 | [diff] [blame] | 1539 | def svs_table_add_del(self, af, table_id, is_add=1): |
| 1540 | return self.api(self.papi.svs_table_add_del, |
| 1541 | { |
| 1542 | 'table_id': table_id, |
| 1543 | 'is_add': is_add, |
| 1544 | 'af': af, |
| 1545 | }) |
| 1546 | |
| 1547 | def svs_route_add_del(self, table_id, prefix, src_table_id, is_add=1): |
| 1548 | return self.api(self.papi.svs_route_add_del, |
| 1549 | { |
| 1550 | 'table_id': table_id, |
| 1551 | 'source_table_id': src_table_id, |
| 1552 | 'prefix': prefix, |
| 1553 | 'is_add': is_add, |
| 1554 | }) |
| 1555 | |
| 1556 | def svs_enable_disable(self, af, table_id, sw_if_index, is_enable=1): |
| 1557 | return self.api(self.papi.svs_enable_disable, |
| 1558 | { |
| 1559 | 'af': af, |
| 1560 | 'table_id': table_id, |
| 1561 | 'sw_if_index': sw_if_index, |
| 1562 | 'is_enable': is_enable, |
| 1563 | }) |
Mohsin Kazmi | 29467b5 | 2019-10-08 19:42:38 +0200 | [diff] [blame] | 1564 | |
| 1565 | def feature_gso_enable_disable(self, sw_if_index, enable_disable=1): |
| 1566 | return self.api(self.papi.feature_gso_enable_disable, |
| 1567 | { |
| 1568 | 'sw_if_index': sw_if_index, |
| 1569 | 'enable_disable': enable_disable, |
| 1570 | }) |