blob: 2e970d247042802fc39b6702a4386e485e01eac2 [file] [log] [blame]
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001import os
2import fnmatch
3import time
Klement Sekeraf62ae122016-10-11 11:47:09 +02004from hook import Hook
Klement Sekerae4504c62016-12-08 10:16:41 +01005from collections import deque
Klement Sekeraf62ae122016-10-11 11:47:09 +02006
Klement Sekera0e3c0de2016-09-29 14:43:44 +02007# Sphinx creates auto-generated documentation by importing the python source
Klement Sekerada505f62017-01-04 12:58:53 +01008# files and collecting the docstrings from them. The NO_VPP_PAPI flag allows
9# the vpp_papi_provider.py file to be importable without having to build
10# the whole vpp api if the user only wishes to generate the test documentation.
Klement Sekera277b89c2016-10-28 13:20:27 +020011do_import = True
12try:
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
15 do_import = False
16except:
17 pass
18
19if do_import:
Ole Troan7e3a8752016-12-05 10:27:09 +010020 from vpp_papi import VPP
Klement Sekera277b89c2016-10-28 13:20:27 +020021
Klement Sekeraf62ae122016-10-11 11:47:09 +020022# from vnet/vnet/mpls/mpls_types.h
23MPLS_IETF_MAX_LABEL = 0xfffff
24MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
25
Klement Sekera0e3c0de2016-09-29 14:43:44 +020026
Neale Ranns177bbdc2016-11-15 09:46:51 +000027class L2_VTR_OP:
Eyal Bari284293a2017-06-06 14:18:55 +030028 L2_DISABLED = 0
29 L2_PUSH_1 = 1
30 L2_PUSH_2 = 2
Neale Ranns177bbdc2016-11-15 09:46:51 +000031 L2_POP_1 = 3
Eyal Bari284293a2017-06-06 14:18:55 +030032 L2_POP_2 = 4
33 L2_TRANSLATE_1_1 = 5
34 L2_TRANSLATE_1_2 = 6
35 L2_TRANSLATE_2_1 = 7
36 L2_TRANSLATE_2_2 = 8
Neale Ranns177bbdc2016-11-15 09:46:51 +000037
Klement Sekera0e3c0de2016-09-29 14:43:44 +020038
Klement Sekera73884482017-02-23 09:26:30 +010039class UnexpectedApiReturnValueError(Exception):
40 """ exception raised when the API return value is unexpected """
41 pass
42
43
Klement Sekeraf62ae122016-10-11 11:47:09 +020044class VppPapiProvider(object):
45 """VPP-api provider using vpp-papi
46
47 @property hook: hook object providing before and after api/cli hooks
Klement Sekeraf62ae122016-10-11 11:47:09 +020048 """
49
Klement Sekerae0545ef2017-01-25 08:00:40 +010050 _zero, _negative = range(2)
51
Klement Sekera7bb873a2016-11-18 07:38:42 +010052 def __init__(self, name, shm_prefix, test_class):
Klement Sekera277b89c2016-10-28 13:20:27 +020053 self.hook = Hook("vpp-papi-provider")
Klement Sekeraf62ae122016-10-11 11:47:09 +020054 self.name = name
55 self.shm_prefix = shm_prefix
Klement Sekera7bb873a2016-11-18 07:38:42 +010056 self.test_class = test_class
Klement Sekerae0545ef2017-01-25 08:00:40 +010057 self._expect_api_retval = self._zero
58 self._expect_stack = []
Ole Troan7e3a8752016-12-05 10:27:09 +010059 jsonfiles = []
60
Klement Sekera0e3c0de2016-09-29 14:43:44 +020061 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
Ole Troan7e3a8752016-12-05 10:27:09 +010062 for root, dirnames, filenames in os.walk(install_dir):
63 for filename in fnmatch.filter(filenames, '*.api.json'):
64 jsonfiles.append(os.path.join(root, filename))
65
Ole Troan3cc49712017-03-08 12:02:24 +010066 self.vpp = VPP(jsonfiles, logger=test_class.logger)
Klement Sekerae4504c62016-12-08 10:16:41 +010067 self._events = deque()
Klement Sekeraf62ae122016-10-11 11:47:09 +020068
Klement Sekerae0545ef2017-01-25 08:00:40 +010069 def __enter__(self):
70 return self
71
72 def expect_negative_api_retval(self):
73 """ Expect API failure """
74 self._expect_stack.append(self._expect_api_retval)
75 self._expect_api_retval = self._negative
76 return self
77
78 def expect_zero_api_retval(self):
79 """ Expect API success """
80 self._expect_stack.append(self._expect_api_retval)
81 self._expect_api_retval = self._zero
82 return self
83
84 def __exit__(self, exc_type, exc_value, traceback):
85 self._expect_api_retval = self._expect_stack.pop()
86
Klement Sekeraf62ae122016-10-11 11:47:09 +020087 def register_hook(self, hook):
88 """Replace hook registration with new hook
89
90 :param hook:
91
92 """
93 self.hook = hook
94
Klement Sekera0e3c0de2016-09-29 14:43:44 +020095 def collect_events(self):
Klement Sekerae4504c62016-12-08 10:16:41 +010096 """ Collect all events from the internal queue and clear the queue. """
Klement Sekera0e3c0de2016-09-29 14:43:44 +020097 e = self._events
Klement Sekerae4504c62016-12-08 10:16:41 +010098 self._events = deque()
Klement Sekera0e3c0de2016-09-29 14:43:44 +020099 return e
100
101 def wait_for_event(self, timeout, name=None):
Klement Sekerae4504c62016-12-08 10:16:41 +0100102 """ Wait for and return next event. """
Klement Sekeraacb9b8e2017-02-14 02:55:31 +0100103 if name:
Klement Sekeraacb9b8e2017-02-14 02:55:31 +0100104 self.test_class.logger.debug("Expecting event '%s' within %ss",
105 name, timeout)
Eyal Bari20197482017-09-13 12:29:08 +0300106 else:
107 self.test_class.logger.debug("Expecting event within %ss",
108 timeout)
Klement Sekerae4504c62016-12-08 10:16:41 +0100109 if self._events:
110 self.test_class.logger.debug("Not waiting, event already queued")
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200111 limit = time.time() + timeout
112 while time.time() < limit:
113 if self._events:
Klement Sekerae4504c62016-12-08 10:16:41 +0100114 e = self._events.popleft()
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200115 if name and type(e).__name__ != name:
116 raise Exception(
117 "Unexpected event received: %s, expected: %s" %
118 (type(e).__name__, name))
Klement Sekerae4504c62016-12-08 10:16:41 +0100119 self.test_class.logger.debug("Returning event %s:%s" %
120 (name, e))
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200121 return e
122 time.sleep(0) # yield
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200123 raise Exception("Event did not occur within timeout")
124
125 def __call__(self, name, event):
Klement Sekerae4504c62016-12-08 10:16:41 +0100126 """ Enqueue event in the internal event queue. """
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200127 # FIXME use the name instead of relying on type(e).__name__ ?
128 # FIXME #2 if this throws, it is eaten silently, Ole?
Klement Sekerae4504c62016-12-08 10:16:41 +0100129 self.test_class.logger.debug("New event: %s: %s" % (name, event))
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200130 self._events.append(event)
131
Klement Sekeraf62ae122016-10-11 11:47:09 +0200132 def connect(self):
133 """Connect the API to VPP"""
Klement Sekera7112c542017-03-01 09:53:19 +0100134 self.vpp.connect(self.name, self.shm_prefix)
135 self.papi = self.vpp.api
136 self.vpp.register_event_callback(self)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200137
138 def disconnect(self):
139 """Disconnect the API from VPP"""
Klement Sekera7112c542017-03-01 09:53:19 +0100140 self.vpp.disconnect()
Klement Sekeraf62ae122016-10-11 11:47:09 +0200141
142 def api(self, api_fn, api_args, expected_retval=0):
Klement Sekerae4504c62016-12-08 10:16:41 +0100143 """ Call API function and check it's return value.
Klement Sekeraf62ae122016-10-11 11:47:09 +0200144 Call the appropriate hooks before and after the API call
145
146 :param api_fn: API function to call
147 :param api_args: tuple of API function arguments
148 :param expected_retval: Expected return value (Default value = 0)
149 :returns: reply from the API
150
151 """
152 self.hook.before_api(api_fn.__name__, api_args)
Ole Troan7e3a8752016-12-05 10:27:09 +0100153 reply = api_fn(**api_args)
Klement Sekerae0545ef2017-01-25 08:00:40 +0100154 if self._expect_api_retval == self._negative:
155 if hasattr(reply, 'retval') and reply.retval >= 0:
156 msg = "API call passed unexpectedly: expected negative "\
157 "return value instead of %d in %s" % \
158 (reply.retval, repr(reply))
159 self.test_class.logger.info(msg)
Klement Sekera73884482017-02-23 09:26:30 +0100160 raise UnexpectedApiReturnValueError(msg)
Klement Sekerae0545ef2017-01-25 08:00:40 +0100161 elif self._expect_api_retval == self._zero:
162 if hasattr(reply, 'retval') and reply.retval != expected_retval:
Neale Ranns88fc83e2017-04-05 08:11:14 -0700163 msg = "API call failed, expected %d return value instead "\
164 "of %d in %s" % (expected_retval, reply.retval,
165 repr(reply))
Klement Sekerae0545ef2017-01-25 08:00:40 +0100166 self.test_class.logger.info(msg)
Klement Sekera73884482017-02-23 09:26:30 +0100167 raise UnexpectedApiReturnValueError(msg)
Klement Sekerae0545ef2017-01-25 08:00:40 +0100168 else:
169 raise Exception("Internal error, unexpected value for "
170 "self._expect_api_retval %s" %
171 self._expect_api_retval)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200172 self.hook.after_api(api_fn.__name__, api_args)
173 return reply
174
175 def cli(self, cli):
Klement Sekerae4504c62016-12-08 10:16:41 +0100176 """ Execute a CLI, calling the before/after hooks appropriately.
Klement Sekeraf62ae122016-10-11 11:47:09 +0200177
178 :param cli: CLI to execute
179 :returns: CLI output
180
181 """
182 self.hook.before_cli(cli)
183 cli += '\n'
Ole Troan7e3a8752016-12-05 10:27:09 +0100184 r = self.papi.cli_inband(length=len(cli), cmd=cli)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200185 self.hook.after_cli(cli)
Jan49c0fca2016-10-26 15:44:27 +0200186 if hasattr(r, 'reply'):
Ole Troan7e3a8752016-12-05 10:27:09 +0100187 return r.reply.decode().rstrip('\x00')
Klement Sekeraf62ae122016-10-11 11:47:09 +0200188
Jan49c0fca2016-10-26 15:44:27 +0200189 def ppcli(self, cli):
Klement Sekerae4504c62016-12-08 10:16:41 +0100190 """ Helper method to print CLI command in case of info logging level.
Jan49c0fca2016-10-26 15:44:27 +0200191
192 :param cli: CLI to execute
193 :returns: CLI output
194 """
Ed Warnickeb8ff5d62016-11-28 13:59:22 -0600195 return cli + "\n" + str(self.cli(cli))
Jan49c0fca2016-10-26 15:44:27 +0200196
Jan4af521d2016-11-15 17:05:00 +0100197 def _convert_mac(self, mac):
198 return int(mac.replace(":", ""), 16) << 16
199
Klement Sekeraf62ae122016-10-11 11:47:09 +0200200 def show_version(self):
201 """ """
Klement Sekera7112c542017-03-01 09:53:19 +0100202 return self.api(self.papi.show_version, {})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200203
204 def pg_create_interface(self, pg_index):
205 """
206
207 :param pg_index:
208
209 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100210 return self.api(self.papi.pg_create_interface,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200211 {"interface_id": pg_index})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200212
213 def sw_interface_dump(self, filter=None):
214 """
215
216 :param filter: (Default value = None)
217
218 """
219 if filter is not None:
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200220 args = {"name_filter_valid": 1, "name_filter": filter}
Klement Sekeraf62ae122016-10-11 11:47:09 +0200221 else:
Ole Troan7e3a8752016-12-05 10:27:09 +0100222 args = {}
223 return self.api(self.papi.sw_interface_dump, args)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200224
Neale Ranns8fe8cc22016-11-01 10:05:08 +0000225 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
Klement Sekerae4504c62016-12-08 10:16:41 +0100226 """ Set the IPvX Table-id for the Interface
Neale Ranns8fe8cc22016-11-01 10:05:08 +0000227
228 :param sw_if_index:
229 :param is_ipv6:
230 :param table_id:
231
232 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100233 return self.api(self.papi.sw_interface_set_table,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200234 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
235 'vrf_id': table_id})
Neale Ranns8fe8cc22016-11-01 10:05:08 +0000236
Klement Sekeraf62ae122016-10-11 11:47:09 +0200237 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
238 is_ipv6=0, is_add=1, del_all=0):
239 """
240
241 :param addr: param is_ipv6: (Default value = 0)
242 :param sw_if_index:
243 :param addr_len:
244 :param is_ipv6: (Default value = 0)
245 :param is_add: (Default value = 1)
246 :param del_all: (Default value = 0)
247
248 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100249 return self.api(self.papi.sw_interface_add_del_address,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200250 {'sw_if_index': sw_if_index,
251 'is_add': is_add,
252 'is_ipv6': is_ipv6,
253 'del_all': del_all,
254 'address_length': addr_len,
255 'address': addr})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200256
Neale Ranns39f9d8b2017-02-16 21:57:05 -0800257 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
258 is_add=1):
259 """ Set the Interface to be unnumbered
260
261 :param is_add: (Default value = 1)
262 :param sw_if_index - interface That will be unnumbered
263 :param ip_sw_if_index - interface with an IP addres
264
265 """
266 return self.api(self.papi.sw_interface_set_unnumbered,
267 {'sw_if_index': ip_sw_if_index,
268 'unnumbered_sw_if_index': sw_if_index,
269 'is_add': is_add})
270
Neale Ranns8fe8cc22016-11-01 10:05:08 +0000271 def sw_interface_enable_disable_mpls(self, sw_if_index,
272 is_enable=1):
273 """
274 Enable/Disable MPLS on the interface
275 :param sw_if_index:
276 :param is_enable: (Default value = 1)
277
278 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100279 return self.api(self.papi.sw_interface_set_mpls_enable,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200280 {'sw_if_index': sw_if_index,
281 'enable': is_enable})
Neale Ranns8fe8cc22016-11-01 10:05:08 +0000282
Jan Gelety057bb8c2016-12-20 17:32:45 +0100283 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
Ole Troan7e3a8752016-12-05 10:27:09 +0100284 return self.api(self.papi.sw_interface_ip6nd_ra_config,
Jan Gelety057bb8c2016-12-20 17:32:45 +0100285 {'sw_if_index': sw_if_index,
286 'suppress': suppress})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200287
Neale Ranns227038a2017-04-21 01:07:59 -0700288 def set_ip_flow_hash(self,
289 table_id,
290 src=1,
291 dst=1,
292 sport=1,
293 dport=1,
294 proto=1,
295 reverse=0,
296 is_ip6=0):
297 return self.api(self.papi.set_ip_flow_hash,
298 {'vrf_id': table_id,
299 'src': src,
300 'dst': dst,
301 'dport': dport,
302 'sport': sport,
303 'proto': proto,
304 'reverse': reverse,
305 'is_ipv6': is_ip6})
306
Neale Ranns3f844d02017-02-18 00:03:54 -0800307 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
308 return self.api(self.papi.ip6nd_proxy_add_del,
309 {'address': address,
310 'sw_if_index': sw_if_index,
311 'is_del': is_del})
312
Neale Ranns75152282017-01-09 01:00:45 -0800313 def ip6_sw_interface_ra_config(self, sw_if_index,
Neale Ranns32e1c012016-11-22 17:07:28 +0000314 no,
Neale Ranns75152282017-01-09 01:00:45 -0800315 suppress,
Neale Ranns32e1c012016-11-22 17:07:28 +0000316 send_unicast):
Neale Ranns75152282017-01-09 01:00:45 -0800317 return self.api(self.papi.sw_interface_ip6nd_ra_config,
318 {'sw_if_index': sw_if_index,
Neale Ranns32e1c012016-11-22 17:07:28 +0000319 'is_no': no,
Klement Sekerada505f62017-01-04 12:58:53 +0100320 'suppress': suppress,
321 'send_unicast': send_unicast})
Neale Ranns75152282017-01-09 01:00:45 -0800322
Neale Ranns87df12d2017-02-18 08:16:41 -0800323 def ip6_sw_interface_ra_prefix(self,
324 sw_if_index,
325 address,
326 address_length,
327 use_default=0,
328 no_advertise=0,
329 off_link=0,
330 no_autoconfig=0,
331 no_onlink=0,
332 is_no=0,
333 val_lifetime=0xffffffff,
334 pref_lifetime=0xffffffff):
335 return self.api(self.papi.sw_interface_ip6nd_ra_prefix,
336 {'sw_if_index': sw_if_index,
337 'address': address,
338 'address_length': address_length,
339 'use_default': use_default,
340 'no_advertise': no_advertise,
341 'off_link': off_link,
342 'no_autoconfig': no_autoconfig,
343 'no_onlink': no_onlink,
344 'is_no': is_no,
345 'val_lifetime': val_lifetime,
346 'pref_lifetime': pref_lifetime})
347
Neale Ranns75152282017-01-09 01:00:45 -0800348 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
349 """
350 Enable/Disable An interface for IPv6
351 """
352 return self.api(self.papi.sw_interface_ip6_enable_disable,
353 {'sw_if_index': sw_if_index,
354 'enable': enable})
355
Klement Sekeraf62ae122016-10-11 11:47:09 +0200356 def vxlan_add_del_tunnel(
357 self,
358 src_addr,
359 dst_addr,
Eyal Baric5b13602016-11-24 19:42:43 +0200360 mcast_sw_if_index=0xFFFFFFFF,
Klement Sekeraf62ae122016-10-11 11:47:09 +0200361 is_add=1,
362 is_ipv6=0,
363 encap_vrf_id=0,
364 decap_next_index=0xFFFFFFFF,
365 vni=0):
366 """
367
368 :param dst_addr:
369 :param src_addr:
370 :param is_add: (Default value = 1)
371 :param is_ipv6: (Default value = 0)
372 :param encap_vrf_id: (Default value = 0)
373 :param decap_next_index: (Default value = 0xFFFFFFFF)
Eyal Baric5b13602016-11-24 19:42:43 +0200374 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200375 :param vni: (Default value = 0)
376
377 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100378 return self.api(self.papi.vxlan_add_del_tunnel,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200379 {'is_add': is_add,
380 'is_ipv6': is_ipv6,
381 'src_address': src_addr,
382 'dst_address': dst_addr,
383 'mcast_sw_if_index': mcast_sw_if_index,
384 'encap_vrf_id': encap_vrf_id,
385 'decap_next_index': decap_next_index,
386 'vni': vni})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200387
Marco Varleseb598f1d2017-09-19 14:25:28 +0200388 def geneve_add_del_tunnel(
389 self,
390 local_addr,
391 remote_addr,
392 mcast_sw_if_index=0xFFFFFFFF,
393 is_add=1,
394 is_ipv6=0,
395 encap_vrf_id=0,
396 decap_next_index=0xFFFFFFFF,
397 vni=0):
398 """
399
400 :param remote_addr:
401 :param local_addr:
402 :param is_add: (Default value = 1)
403 :param is_ipv6: (Default value = 0)
404 :param encap_vrf_id: (Default value = 0)
405 :param decap_next_index: (Default value = 0xFFFFFFFF)
406 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
407 :param vni: (Default value = 0)
408
409 """
410 return self.api(self.papi.geneve_add_del_tunnel,
411 {'is_add': is_add,
412 'is_ipv6': is_ipv6,
413 'local_address': local_addr,
414 'remote_address': remote_addr,
415 'mcast_sw_if_index': mcast_sw_if_index,
416 'encap_vrf_id': encap_vrf_id,
417 'decap_next_index': decap_next_index,
418 'vni': vni})
419
Jan4af521d2016-11-15 17:05:00 +0100420 def bridge_domain_add_del(self, bd_id, flood=1, uu_flood=1, forward=1,
421 learn=1, arp_term=0, is_add=1):
422 """Create/delete bridge domain.
423
424 :param int bd_id: Bridge domain index.
425 :param int flood: Enable/disable bcast/mcast flooding in the BD.
426 (Default value = 1)
427 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
428 (Default value = 1)
429 :param int forward: Enable/disable forwarding on all interfaces in
430 the BD. (Default value = 1)
431 :param int learn: Enable/disable learning on all interfaces in the BD.
432 (Default value = 1)
433 :param int arp_term: Enable/disable arp termination in the BD.
434 (Default value = 1)
435 :param int is_add: Add or delete flag. (Default value = 1)
436 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100437 return self.api(self.papi.bridge_domain_add_del,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200438 {'bd_id': bd_id,
439 'flood': flood,
440 'uu_flood': uu_flood,
441 'forward': forward,
442 'learn': learn,
443 'arp_term': arp_term,
444 'is_add': is_add})
Jan4af521d2016-11-15 17:05:00 +0100445
Eyal Baric86e5922017-07-02 18:33:16 +0300446 def bd_ip_mac_add_del(self, bd_id, mac, ip, is_ipv6=0, is_add=1):
447 return self.api(self.papi.bd_ip_mac_add_del,
448 {'bd_id': bd_id,
449 'is_add': is_add,
450 'is_ipv6': is_ipv6,
451 'ip_address': ip,
452 'mac_address': mac})
453
Eyal Bari20197482017-09-13 12:29:08 +0300454 def want_ip4_arp_events(self, enable_disable=1, address=0):
455 return self.api(self.papi.want_ip4_arp_events,
456 {'enable_disable': enable_disable,
457 'address': address,
458 'pid': os.getpid(), })
459
Eyal Baric125ecc2017-09-20 11:29:17 +0300460 def want_ip6_nd_events(self, enable_disable=1, address=0):
461 return self.api(self.papi.want_ip6_nd_events,
462 {'enable_disable': enable_disable,
463 'address': address,
464 'pid': os.getpid(), })
465
Eyal Bari24db0ec2017-09-27 21:43:51 +0300466 def want_macs_learn_events(self, enable_disable=1, scan_delay=0,
467 max_macs_in_event=0, learn_limit=0):
468 return self.api(self.papi.want_l2_macs_events,
469 {'enable_disable': enable_disable,
470 'scan_delay': scan_delay,
471 'max_macs_in_event': max_macs_in_event,
472 'learn_limit': learn_limit,
473 'pid': os.getpid(), })
474
Jan4af521d2016-11-15 17:05:00 +0100475 def l2fib_add_del(self, mac, bd_id, sw_if_index, is_add=1, static_mac=0,
476 filter_mac=0, bvi_mac=0):
477 """Create/delete L2 FIB entry.
478
479 :param str mac: MAC address to create FIB entry for.
480 :param int bd_id: Bridge domain index.
481 :param int sw_if_index: Software interface index of the interface.
482 :param int is_add: Add or delete flag. (Default value = 1)
483 :param int static_mac: Set to 1 to create static MAC entry.
484 (Default value = 0)
485 :param int filter_mac: Set to 1 to drop packet that's source or
486 destination MAC address contains defined MAC address.
487 (Default value = 0)
488 :param int bvi_mac: Set to 1 to create entry that points to BVI
489 interface. (Default value = 0)
490 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100491 return self.api(self.papi.l2fib_add_del,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200492 {'mac': self._convert_mac(mac),
493 'bd_id': bd_id,
494 'sw_if_index': sw_if_index,
495 'is_add': is_add,
496 'static_mac': static_mac,
497 'filter_mac': filter_mac,
498 'bvi_mac': bvi_mac})
Jan4af521d2016-11-15 17:05:00 +0100499
Eyal Bari93b503e2017-05-15 10:13:15 +0300500 def l2fib_flush_int(self, sw_if_index):
501 """Flush L2 FIB entries for sw_if_index.
502
503 :param int sw_if_index: Software interface index of the interface.
504 """
505 return self.api(self.papi.l2fib_flush_int,
506 {'sw_if_index': sw_if_index})
507
508 def l2fib_flush_bd(self, bd_id):
509 """Flush L2 FIB entries for bd_id.
510
511 :param int sw_if_index: Bridge Domain id.
512 """
513 return self.api(self.papi.l2fib_flush_bd,
514 {'bd_id': bd_id})
515
516 def l2fib_flush_all(self):
517 """Flush all L2 FIB.
518 """
519 return self.api(self.papi.l2fib_flush_all, {})
520
Klement Sekeraf62ae122016-10-11 11:47:09 +0200521 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
522 shg=0, bvi=0, enable=1):
Jan4af521d2016-11-15 17:05:00 +0100523 """Add/remove interface to/from bridge domain.
Klement Sekeraf62ae122016-10-11 11:47:09 +0200524
Jan4af521d2016-11-15 17:05:00 +0100525 :param int sw_if_index: Software interface index of the interface.
526 :param int bd_id: Bridge domain index.
527 :param int shg: Split-horizon group index. (Default value = 0)
528 :param int bvi: Set interface as a bridge group virtual interface.
529 (Default value = 0)
530 :param int enable: Add or remove interface. (Default value = 1)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200531 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100532 return self.api(self.papi.sw_interface_set_l2_bridge,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200533 {'rx_sw_if_index': sw_if_index,
534 'bd_id': bd_id,
535 'shg': shg,
536 'bvi': bvi,
537 'enable': enable})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200538
Jan00dad122016-11-29 10:04:53 +0100539 def bridge_flags(self, bd_id, is_set, feature_bitmap):
540 """Enable/disable required feature of the bridge domain with defined ID.
541
542 :param int bd_id: Bridge domain ID.
543 :param int is_set: Set to 1 to enable, set to 0 to disable the feature.
544 :param int feature_bitmap: Bitmap value of the feature to be set:
545 - learn (1 << 0),
546 - forward (1 << 1),
547 - flood (1 << 2),
548 - uu-flood (1 << 3) or
549 - arp-term (1 << 4).
550 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100551 return self.api(self.papi.bridge_flags,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200552 {'bd_id': bd_id,
553 'is_set': is_set,
554 'feature_bitmap': feature_bitmap})
Jan00dad122016-11-29 10:04:53 +0100555
556 def bridge_domain_dump(self, bd_id=0):
557 """
558
559 :param int bd_id: Bridge domain ID. (Default value = 0 => dump of all
560 existing bridge domains returned)
561 :return: Dictionary of bridge domain(s) data.
562 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100563 return self.api(self.papi.bridge_domain_dump,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200564 {'bd_id': bd_id})
Jan00dad122016-11-29 10:04:53 +0100565
Klement Sekeraf62ae122016-10-11 11:47:09 +0200566 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
567 enable):
568 """Create or delete unidirectional cross-connect from Tx interface to
569 Rx interface.
570
Jan4af521d2016-11-15 17:05:00 +0100571 :param int rx_sw_if_index: Software interface index of Rx interface.
572 :param int tx_sw_if_index: Software interface index of Tx interface.
573 :param int enable: Create cross-connect if equal to 1, delete
574 cross-connect if equal to 0.
Klement Sekeraf62ae122016-10-11 11:47:09 +0200575
576 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100577 return self.api(self.papi.sw_interface_set_l2_xconnect,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200578 {'rx_sw_if_index': rx_sw_if_index,
579 'tx_sw_if_index': tx_sw_if_index,
580 'enable': enable})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200581
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200582 def sw_interface_set_l2_tag_rewrite(
583 self,
584 sw_if_index,
585 vtr_oper,
586 push=0,
587 tag1=0,
588 tag2=0):
Neale Ranns177bbdc2016-11-15 09:46:51 +0000589 """L2 interface vlan tag rewrite configure request
590 :param client_index - opaque cookie to identify the sender
591 :param context - sender context, to match reply w/ request
592 :param sw_if_index - interface the operation is applied to
593 :param vtr_op - Choose from l2_vtr_op_t enum values
594 :param push_dot1q - first pushed flag dot1q id set, else dot1ad
595 :param tag1 - Needed for any push or translate vtr op
596 :param tag2 - Needed for any push 2 or translate x-2 vtr ops
597
598 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100599 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200600 {'sw_if_index': sw_if_index,
601 'vtr_op': vtr_oper,
602 'push_dot1q': push,
603 'tag1': tag1,
604 'tag2': tag2})
Neale Ranns177bbdc2016-11-15 09:46:51 +0000605
Neale Rannsa07bd702017-08-07 07:53:49 -0700606 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
Klement Sekeraf62ae122016-10-11 11:47:09 +0200607 """
608
609 :param admin_up_down:
610 :param sw_if_index:
Klement Sekeraf62ae122016-10-11 11:47:09 +0200611
612 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100613 return self.api(self.papi.sw_interface_set_flags,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200614 {'sw_if_index': sw_if_index,
Neale Rannsa07bd702017-08-07 07:53:49 -0700615 'admin_up_down': admin_up_down})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200616
617 def create_subif(self, sw_if_index, sub_id, outer_vlan, inner_vlan,
618 no_tags=0, one_tag=0, two_tags=0, dot1ad=0, exact_match=0,
619 default_sub=0, outer_vlan_id_any=0, inner_vlan_id_any=0):
620 """Create subinterface
621 from vpe.api: set dot1ad = 0 for dot1q, set dot1ad = 1 for dot1ad
622
623 :param sub_id: param inner_vlan:
624 :param sw_if_index:
625 :param outer_vlan:
626 :param inner_vlan:
627 :param no_tags: (Default value = 0)
628 :param one_tag: (Default value = 0)
629 :param two_tags: (Default value = 0)
630 :param dot1ad: (Default value = 0)
631 :param exact_match: (Default value = 0)
632 :param default_sub: (Default value = 0)
633 :param outer_vlan_id_any: (Default value = 0)
634 :param inner_vlan_id_any: (Default value = 0)
635
636 """
637 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +0100638 self.papi.create_subif,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200639 {'sw_if_index': sw_if_index,
640 'sub_id': sub_id,
641 'no_tags': no_tags,
642 'one_tag': one_tag,
643 'two_tags': two_tags,
644 'dot1ad': dot1ad,
645 'exact_match': exact_match,
646 'default_sub': default_sub,
647 'outer_vlan_id_any': outer_vlan_id_any,
648 'inner_vlan_id_any': inner_vlan_id_any,
649 'outer_vlan_id': outer_vlan,
650 'inner_vlan_id': inner_vlan})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200651
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200652 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
653 """Create p2p ethernet subinterface
654
655 :param sw_if_index: main (parent) interface
656 :param remote_mac: client (remote) mac address
657
658 """
659 return self.api(
660 self.papi.p2p_ethernet_add,
661 {'parent_if_index': sw_if_index,
662 'remote_mac': remote_mac,
663 'subif_id': subif_id})
664
Neale Ranns177bbdc2016-11-15 09:46:51 +0000665 def delete_subif(self, sw_if_index):
666 """Delete subinterface
667
668 :param sw_if_index:
669 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100670 return self.api(self.papi.delete_subif,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200671 {'sw_if_index': sw_if_index})
Neale Ranns177bbdc2016-11-15 09:46:51 +0000672
Pavel Kotucek15ac81c2017-06-20 14:00:26 +0200673 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
674 """Delete p2p ethernet subinterface
675
676 :param sw_if_index: main (parent) interface
677 :param remote_mac: client (remote) mac address
678
679 """
680 return self.api(
681 self.papi.p2p_ethernet_del,
682 {'parent_if_index': sw_if_index,
683 'remote_mac': remote_mac})
684
Klement Sekeraf62ae122016-10-11 11:47:09 +0200685 def create_vlan_subif(self, sw_if_index, vlan):
686 """
687
688 :param vlan:
689 :param sw_if_index:
690
691 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100692 return self.api(self.papi.create_vlan_subif,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200693 {'sw_if_index': sw_if_index,
694 'vlan_id': vlan})
Klement Sekeraf62ae122016-10-11 11:47:09 +0200695
Matej Klotton0178d522016-11-04 11:11:44 +0100696 def create_loopback(self, mac=''):
697 """
698
699 :param mac: (Optional)
700 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100701 return self.api(self.papi.create_loopback,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200702 {'mac_address': mac})
Matej Klotton0178d522016-11-04 11:11:44 +0100703
Matej Klotton8d8a1da2016-12-22 11:06:56 +0100704 def delete_loopback(self, sw_if_index):
705 return self.api(self.papi.delete_loopback,
706 {'sw_if_index': sw_if_index, })
707
Neale Ranns15002542017-09-10 04:39:11 -0700708 def ip_table_add_del(self,
709 table_id,
710 is_add=1,
711 is_ipv6=0):
712 """
713
714 :param table_id
715 :param is_add: (Default value = 1)
716 :param is_ipv6: (Default value = 0)
717
718 """
719
720 return self.api(
721 self.papi.ip_table_add_del,
722 {'table_id': table_id,
723 'is_add': is_add,
724 'is_ipv6': is_ipv6})
725
Klement Sekeraf62ae122016-10-11 11:47:09 +0200726 def ip_add_del_route(
727 self,
728 dst_address,
729 dst_address_length,
730 next_hop_address,
731 next_hop_sw_if_index=0xFFFFFFFF,
732 table_id=0,
Klement Sekeraf62ae122016-10-11 11:47:09 +0200733 next_hop_table_id=0,
Neale Rannsad422ed2016-11-02 14:20:04 +0000734 next_hop_weight=1,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200735 next_hop_n_out_labels=0,
736 next_hop_out_label_stack=[],
737 next_hop_via_label=MPLS_LABEL_INVALID,
Neale Rannsad422ed2016-11-02 14:20:04 +0000738 is_resolve_host=0,
739 is_resolve_attached=0,
740 classify_table_index=0xFFFFFFFF,
Klement Sekeraf62ae122016-10-11 11:47:09 +0200741 is_add=1,
742 is_drop=0,
Juraj Sloboda86a2c572016-10-27 10:44:25 +0200743 is_unreach=0,
744 is_prohibit=0,
Klement Sekeraf62ae122016-10-11 11:47:09 +0200745 is_ipv6=0,
746 is_local=0,
747 is_classify=0,
748 is_multipath=0,
Neale Ranns6f631152017-10-03 08:20:21 -0700749 is_l2_bridged=0,
Marek Gradzki0164a062017-10-13 10:22:59 +0200750 is_source_lookup=0):
Klement Sekeraf62ae122016-10-11 11:47:09 +0200751 """
752
753 :param dst_address_length:
754 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
755 :param dst_address:
756 :param next_hop_address:
757 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
758 :param vrf_id: (Default value = 0)
759 :param lookup_in_vrf: (Default value = 0)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200760 :param classify_table_index: (Default value = 0xFFFFFFFF)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200761 :param is_add: (Default value = 1)
762 :param is_drop: (Default value = 0)
763 :param is_ipv6: (Default value = 0)
764 :param is_local: (Default value = 0)
765 :param is_classify: (Default value = 0)
766 :param is_multipath: (Default value = 0)
767 :param is_resolve_host: (Default value = 0)
768 :param is_resolve_attached: (Default value = 0)
Neale Ranns054c03a2017-10-13 05:15:07 -0700769 :param is_l2_bridged: (Default value = 0)
770 :param is_source_lookup: (Default value = 0)
Klement Sekeraf62ae122016-10-11 11:47:09 +0200771 :param next_hop_weight: (Default value = 1)
772
773 """
Neale Rannsad422ed2016-11-02 14:20:04 +0000774
Klement Sekeraf62ae122016-10-11 11:47:09 +0200775 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +0100776 self.papi.ip_add_del_route,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200777 {'next_hop_sw_if_index': next_hop_sw_if_index,
778 'table_id': table_id,
779 'classify_table_index': classify_table_index,
780 'next_hop_table_id': next_hop_table_id,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200781 'is_add': is_add,
782 'is_drop': is_drop,
783 'is_unreach': is_unreach,
784 'is_prohibit': is_prohibit,
785 'is_ipv6': is_ipv6,
786 'is_local': is_local,
787 'is_classify': is_classify,
788 'is_multipath': is_multipath,
789 'is_resolve_host': is_resolve_host,
790 'is_resolve_attached': is_resolve_attached,
Neale Ranns6f631152017-10-03 08:20:21 -0700791 'is_l2_bridged': is_l2_bridged,
Neale Ranns054c03a2017-10-13 05:15:07 -0700792 'is_source_lookup': is_source_lookup,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200793 'next_hop_weight': next_hop_weight,
794 'dst_address_length': dst_address_length,
795 'dst_address': dst_address,
796 'next_hop_address': next_hop_address,
797 'next_hop_n_out_labels': next_hop_n_out_labels,
798 'next_hop_via_label': next_hop_via_label,
799 'next_hop_out_label_stack': next_hop_out_label_stack})
Matej Klotton0178d522016-11-04 11:11:44 +0100800
Matej Klotton16a14cd2016-12-07 15:09:13 +0100801 def ip_fib_dump(self):
802 return self.api(self.papi.ip_fib_dump, {})
803
Jan Gelety057bb8c2016-12-20 17:32:45 +0100804 def ip6_fib_dump(self):
805 return self.api(self.papi.ip6_fib_dump, {})
806
Matej Klotton0178d522016-11-04 11:11:44 +0100807 def ip_neighbor_add_del(self,
808 sw_if_index,
809 mac_address,
810 dst_address,
Matej Klotton0178d522016-11-04 11:11:44 +0100811 is_add=1,
812 is_ipv6=0,
813 is_static=0,
Neale Rannsb3b2de72017-03-08 05:17:22 -0800814 is_no_adj_fib=0,
Matej Klotton0178d522016-11-04 11:11:44 +0100815 ):
816 """ Add neighbor MAC to IPv4 or IPv6 address.
817
818 :param sw_if_index:
819 :param mac_address:
820 :param dst_address:
Matej Klotton0178d522016-11-04 11:11:44 +0100821 :param is_add: (Default value = 1)
822 :param is_ipv6: (Default value = 0)
823 :param is_static: (Default value = 0)
Neale Rannsb3b2de72017-03-08 05:17:22 -0800824 :param is_no_adj_fib: (Default value = 0)
Matej Klotton0178d522016-11-04 11:11:44 +0100825 """
826
827 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +0100828 self.papi.ip_neighbor_add_del,
Neale Rannsbaf2e902017-02-25 04:20:00 -0800829 {'sw_if_index': sw_if_index,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200830 'is_add': is_add,
831 'is_ipv6': is_ipv6,
832 'is_static': is_static,
Neale Rannsb3b2de72017-03-08 05:17:22 -0800833 'is_no_adj_fib': is_no_adj_fib,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200834 'mac_address': mac_address,
835 'dst_address': dst_address
Ole Troan7e3a8752016-12-05 10:27:09 +0100836 }
Matej Klotton0178d522016-11-04 11:11:44 +0100837 )
Pavel Kotucekf6e3dc42016-11-04 09:58:01 +0100838
Neale Ranns39f9d8b2017-02-16 21:57:05 -0800839 def ip_neighbor_dump(self,
840 sw_if_index,
841 is_ipv6=0):
842 """ Return IP neighbor dump.
843
844 :param sw_if_index:
845 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
846 """
847
848 return self.api(
849 self.papi.ip_neighbor_dump,
850 {'is_ipv6': is_ipv6,
851 'sw_if_index': sw_if_index
852 }
853 )
854
855 def proxy_arp_add_del(self,
856 low_address,
857 hi_address,
858 vrf_id=0,
859 is_add=1):
860 """ Config Proxy Arp Range.
861
862 :param low_address: Start address in the rnage to Proxy for
863 :param hi_address: End address in the rnage to Proxy for
864 :param vrf_id: The VRF/table in which to proxy
865 """
866
867 return self.api(
868 self.papi.proxy_arp_add_del,
869 {'vrf_id': vrf_id,
870 'is_add': is_add,
871 'low_address': low_address,
872 'hi_address': hi_address,
873 }
874 )
875
876 def proxy_arp_intfc_enable_disable(self,
877 sw_if_index,
878 is_enable=1):
879 """ Enable/Disable an interface for proxy ARP requests
880
881 :param sw_if_index: Interface
882 :param enable_disable: Enable/Disable
883 """
884
885 return self.api(
886 self.papi.proxy_arp_intfc_enable_disable,
887 {'sw_if_index': sw_if_index,
888 'enable_disable': is_enable
889 }
890 )
891
Jane546d3b2016-12-08 13:10:03 +0100892 def reset_vrf(self,
893 vrf_id,
894 is_ipv6=0,
895 ):
896 """ Reset VRF (remove all routes etc.) request.
897
898 :param int vrf_id: ID of the FIB table / VRF to reset.
899 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
900 """
901
902 return self.api(
903 self.papi.reset_vrf,
904 {'vrf_id': vrf_id,
905 'is_ipv6': is_ipv6,
906 }
907 )
908
909 def reset_fib(self,
910 vrf_id,
911 is_ipv6=0,
912 ):
913 """ Reset VRF (remove all routes etc.) request.
914
915 :param int vrf_id: ID of the FIB table / VRF to reset.
916 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
917 """
918
919 return self.api(
920 self.papi.reset_fib,
921 {'vrf_id': vrf_id,
922 'is_ipv6': is_ipv6,
923 }
924 )
925
926 def ip_dump(self,
927 is_ipv6=0,
928 ):
929 """ Return IP dump.
930
931 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
932 """
933
934 return self.api(
935 self.papi.ip_dump,
936 {'is_ipv6': is_ipv6,
937 }
938 )
939
Klement Sekera7bb873a2016-11-18 07:38:42 +0100940 def sw_interface_span_enable_disable(
Eyal Bari001fd402017-07-16 09:34:53 +0300941 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
Pavel Kotucekf6e3dc42016-11-04 09:58:01 +0100942 """
943
944 :param sw_if_index_from:
945 :param sw_if_index_to:
Matej Klottondeb69842016-12-09 15:05:46 +0100946 :param state:
Eyal Bari001fd402017-07-16 09:34:53 +0300947 :param is_l2:
Pavel Kotucekf6e3dc42016-11-04 09:58:01 +0100948 """
Ole Troan7e3a8752016-12-05 10:27:09 +0100949 return self.api(self.papi.sw_interface_span_enable_disable,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200950 {'sw_if_index_from': sw_if_index_from,
951 'sw_if_index_to': sw_if_index_to,
Eyal Bari001fd402017-07-16 09:34:53 +0300952 'state': state,
953 'is_l2': is_l2,
954 })
Neale Ranns177bbdc2016-11-15 09:46:51 +0000955
956 def gre_tunnel_add_del(self,
957 src_address,
958 dst_address,
959 outer_fib_id=0,
960 is_teb=0,
961 is_add=1,
962 is_ip6=0):
963 """ Add a GRE tunnel
964
965 :param src_address:
966 :param dst_address:
967 :param outer_fib_id: (Default value = 0)
968 :param is_add: (Default value = 1)
969 :param is_ipv6: (Default value = 0)
970 :param is_teb: (Default value = 0)
971 """
972
973 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +0100974 self.papi.gre_add_del_tunnel,
Klement Sekera0e3c0de2016-09-29 14:43:44 +0200975 {'is_add': is_add,
976 'is_ipv6': is_ip6,
977 'teb': is_teb,
978 'src_address': src_address,
979 'dst_address': dst_address,
980 'outer_fib_id': outer_fib_id}
Neale Ranns177bbdc2016-11-15 09:46:51 +0000981 )
Neale Rannsad422ed2016-11-02 14:20:04 +0000982
Neale Ranns5a8123b2017-01-26 01:18:23 -0800983 def mpls_fib_dump(self):
984 return self.api(self.papi.mpls_fib_dump, {})
985
Neale Ranns15002542017-09-10 04:39:11 -0700986 def mpls_table_add_del(
987 self,
988 table_id,
989 is_add=1):
990 """
991
992 :param table_id
993 :param is_add: (Default value = 1)
994
995 """
996
997 return self.api(
998 self.papi.mpls_table_add_del,
999 {'mt_table_id': table_id,
1000 'mt_is_add': is_add})
1001
Neale Rannsad422ed2016-11-02 14:20:04 +00001002 def mpls_route_add_del(
1003 self,
1004 label,
1005 eos,
Neale Rannsda78f952017-05-24 09:15:43 -07001006 next_hop_proto,
Neale Rannsad422ed2016-11-02 14:20:04 +00001007 next_hop_address,
1008 next_hop_sw_if_index=0xFFFFFFFF,
1009 table_id=0,
1010 next_hop_table_id=0,
1011 next_hop_weight=1,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001012 next_hop_n_out_labels=0,
1013 next_hop_out_label_stack=[],
1014 next_hop_via_label=MPLS_LABEL_INVALID,
Neale Rannsad422ed2016-11-02 14:20:04 +00001015 is_resolve_host=0,
1016 is_resolve_attached=0,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001017 is_interface_rx=0,
1018 is_rpf_id=0,
1019 is_multicast=0,
Neale Rannsad422ed2016-11-02 14:20:04 +00001020 is_add=1,
1021 is_drop=0,
1022 is_multipath=0,
1023 classify_table_index=0xFFFFFFFF,
Marek Gradzki0164a062017-10-13 10:22:59 +02001024 is_classify=0):
Neale Rannsad422ed2016-11-02 14:20:04 +00001025 """
1026
1027 :param dst_address_length:
1028 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1029 :param dst_address:
1030 :param next_hop_address:
1031 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1032 :param vrf_id: (Default value = 0)
1033 :param lookup_in_vrf: (Default value = 0)
1034 :param classify_table_index: (Default value = 0xFFFFFFFF)
Neale Rannsad422ed2016-11-02 14:20:04 +00001035 :param is_add: (Default value = 1)
1036 :param is_drop: (Default value = 0)
1037 :param is_ipv6: (Default value = 0)
1038 :param is_local: (Default value = 0)
1039 :param is_classify: (Default value = 0)
1040 :param is_multipath: (Default value = 0)
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001041 :param is_multicast: (Default value = 0)
Neale Rannsad422ed2016-11-02 14:20:04 +00001042 :param is_resolve_host: (Default value = 0)
1043 :param is_resolve_attached: (Default value = 0)
Neale Rannsad422ed2016-11-02 14:20:04 +00001044 :param next_hop_weight: (Default value = 1)
1045
1046 """
Neale Rannsad422ed2016-11-02 14:20:04 +00001047
1048 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +01001049 self.papi.mpls_route_add_del,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001050 {'mr_label': label,
1051 'mr_eos': eos,
1052 'mr_table_id': table_id,
1053 'mr_classify_table_index': classify_table_index,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001054 'mr_is_add': is_add,
1055 'mr_is_classify': is_classify,
1056 'mr_is_multipath': is_multipath,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001057 'mr_is_multicast': is_multicast,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001058 'mr_is_resolve_host': is_resolve_host,
1059 'mr_is_resolve_attached': is_resolve_attached,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001060 'mr_is_interface_rx': is_interface_rx,
1061 'mr_is_rpf_id': is_rpf_id,
Neale Rannsda78f952017-05-24 09:15:43 -07001062 'mr_next_hop_proto': next_hop_proto,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001063 'mr_next_hop_weight': next_hop_weight,
1064 'mr_next_hop': next_hop_address,
1065 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1066 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1067 'mr_next_hop_table_id': next_hop_table_id,
1068 'mr_next_hop_via_label': next_hop_via_label,
1069 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
Neale Rannsad422ed2016-11-02 14:20:04 +00001070
1071 def mpls_ip_bind_unbind(
1072 self,
1073 label,
1074 dst_address,
1075 dst_address_length,
1076 table_id=0,
1077 ip_table_id=0,
1078 is_ip4=1,
Neale Rannsad422ed2016-11-02 14:20:04 +00001079 is_bind=1):
1080 """
1081 """
1082 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +01001083 self.papi.mpls_ip_bind_unbind,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001084 {'mb_mpls_table_id': table_id,
1085 'mb_label': label,
1086 'mb_ip_table_id': ip_table_id,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001087 'mb_is_bind': is_bind,
1088 'mb_is_ip4': is_ip4,
1089 'mb_address_length': dst_address_length,
1090 'mb_address': dst_address})
Neale Rannsad422ed2016-11-02 14:20:04 +00001091
1092 def mpls_tunnel_add_del(
1093 self,
1094 tun_sw_if_index,
1095 next_hop_proto_is_ip4,
1096 next_hop_address,
1097 next_hop_sw_if_index=0xFFFFFFFF,
1098 next_hop_table_id=0,
1099 next_hop_weight=1,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001100 next_hop_n_out_labels=0,
1101 next_hop_out_label_stack=[],
1102 next_hop_via_label=MPLS_LABEL_INVALID,
Neale Rannsad422ed2016-11-02 14:20:04 +00001103 is_add=1,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001104 l2_only=0,
1105 is_multicast=0):
Neale Rannsad422ed2016-11-02 14:20:04 +00001106 """
1107
1108 :param dst_address_length:
1109 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1110 :param dst_address:
1111 :param next_hop_address:
1112 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1113 :param vrf_id: (Default value = 0)
1114 :param lookup_in_vrf: (Default value = 0)
1115 :param classify_table_index: (Default value = 0xFFFFFFFF)
Neale Rannsad422ed2016-11-02 14:20:04 +00001116 :param is_add: (Default value = 1)
1117 :param is_drop: (Default value = 0)
1118 :param is_ipv6: (Default value = 0)
1119 :param is_local: (Default value = 0)
1120 :param is_classify: (Default value = 0)
1121 :param is_multipath: (Default value = 0)
1122 :param is_resolve_host: (Default value = 0)
1123 :param is_resolve_attached: (Default value = 0)
Neale Rannsad422ed2016-11-02 14:20:04 +00001124 :param next_hop_weight: (Default value = 1)
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001125 :param is_multicast: (Default value = 0)
Neale Rannsad422ed2016-11-02 14:20:04 +00001126
1127 """
Neale Rannsad422ed2016-11-02 14:20:04 +00001128 return self.api(
Ole Troan7e3a8752016-12-05 10:27:09 +01001129 self.papi.mpls_tunnel_add_del,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001130 {'mt_sw_if_index': tun_sw_if_index,
1131 'mt_is_add': is_add,
1132 'mt_l2_only': l2_only,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001133 'mt_is_multicast': is_multicast,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001134 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1135 'mt_next_hop_weight': next_hop_weight,
1136 'mt_next_hop': next_hop_address,
1137 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1138 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1139 'mt_next_hop_table_id': next_hop_table_id,
1140 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
Matus Fabiande886752016-12-07 03:38:19 -08001141
Matus Fabian2ba92e32017-08-21 07:05:03 -07001142 def nat44_interface_add_del_feature(
Matus Fabiande886752016-12-07 03:38:19 -08001143 self,
1144 sw_if_index,
1145 is_inside=1,
1146 is_add=1):
Matus Fabian2ba92e32017-08-21 07:05:03 -07001147 """Enable/disable NAT44 feature on the interface
Matus Fabiande886752016-12-07 03:38:19 -08001148
1149 :param sw_if_index: Software index of the interface
1150 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1151 :param is_add: 1 if add, 0 if delete (Default value = 1)
1152 """
1153 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001154 self.papi.nat44_interface_add_del_feature,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001155 {'is_add': is_add,
1156 'is_inside': is_inside,
1157 'sw_if_index': sw_if_index})
Matus Fabiande886752016-12-07 03:38:19 -08001158
Matus Fabian2ba92e32017-08-21 07:05:03 -07001159 def nat44_interface_add_del_output_feature(
Matus Fabian93d84c92017-07-19 08:06:01 -07001160 self,
1161 sw_if_index,
1162 is_inside=1,
1163 is_add=1):
Matus Fabian2ba92e32017-08-21 07:05:03 -07001164 """Enable/disable NAT44 output feature on the interface
Matus Fabian93d84c92017-07-19 08:06:01 -07001165
1166 :param sw_if_index: Software index of the interface
1167 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1168 :param is_add: 1 if add, 0 if delete (Default value = 1)
1169 """
1170 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001171 self.papi.nat44_interface_add_del_output_feature,
Matus Fabian93d84c92017-07-19 08:06:01 -07001172 {'is_add': is_add,
1173 'is_inside': is_inside,
1174 'sw_if_index': sw_if_index})
1175
Matus Fabian2ba92e32017-08-21 07:05:03 -07001176 def nat44_add_del_static_mapping(
Matus Fabiande886752016-12-07 03:38:19 -08001177 self,
1178 local_ip,
Matus Fabian36532bd2017-01-23 23:42:28 -08001179 external_ip=0,
1180 external_sw_if_index=0xFFFFFFFF,
Matus Fabiande886752016-12-07 03:38:19 -08001181 local_port=0,
1182 external_port=0,
1183 addr_only=1,
1184 vrf_id=0,
Matus Fabian09d96f42017-02-02 01:43:00 -08001185 protocol=0,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001186 is_add=1):
1187 """Add/delete NAT44 static mapping
Matus Fabiande886752016-12-07 03:38:19 -08001188
1189 :param local_ip: Local IP address
1190 :param external_ip: External IP address
Matus Fabian36532bd2017-01-23 23:42:28 -08001191 :param external_sw_if_index: External interface instead of IP address
Matus Fabiande886752016-12-07 03:38:19 -08001192 :param local_port: Local port number (Default value = 0)
1193 :param external_port: External port number (Default value = 0)
1194 :param addr_only: 1 if address only mapping, 0 if address and port
1195 :param vrf_id: VRF ID
Matus Fabian09d96f42017-02-02 01:43:00 -08001196 :param protocol: IP protocol (Default value = 0)
Matus Fabiande886752016-12-07 03:38:19 -08001197 :param is_add: 1 if add, 0 if delete (Default value = 1)
Matus Fabiande886752016-12-07 03:38:19 -08001198 """
1199 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001200 self.papi.nat44_add_del_static_mapping,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001201 {'is_add': is_add,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001202 'addr_only': addr_only,
1203 'local_ip_address': local_ip,
1204 'external_ip_address': external_ip,
1205 'local_port': local_port,
1206 'external_port': external_port,
Matus Fabian36532bd2017-01-23 23:42:28 -08001207 'external_sw_if_index': external_sw_if_index,
Matus Fabian09d96f42017-02-02 01:43:00 -08001208 'vrf_id': vrf_id,
1209 'protocol': protocol})
Matus Fabiande886752016-12-07 03:38:19 -08001210
Matus Fabian2ba92e32017-08-21 07:05:03 -07001211 def nat44_add_del_address_range(
Matus Fabiande886752016-12-07 03:38:19 -08001212 self,
1213 first_ip_address,
1214 last_ip_address,
1215 is_add=1,
Juraj Slobodaeab38d92017-03-06 19:55:21 -08001216 vrf_id=0xFFFFFFFF):
Matus Fabian2ba92e32017-08-21 07:05:03 -07001217 """Add/del NAT44 address range
Matus Fabiande886752016-12-07 03:38:19 -08001218
1219 :param first_ip_address: First IP address
1220 :param last_ip_address: Last IP address
Juraj Slobodaeab38d92017-03-06 19:55:21 -08001221 :param vrf_id: VRF id for the address range
Matus Fabiande886752016-12-07 03:38:19 -08001222 :param is_add: 1 if add, 0 if delete (Default value = 1)
Matus Fabiande886752016-12-07 03:38:19 -08001223 """
1224 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001225 self.papi.nat44_add_del_address_range,
1226 {'first_ip_address': first_ip_address,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001227 'last_ip_address': last_ip_address,
Juraj Slobodaeab38d92017-03-06 19:55:21 -08001228 'vrf_id': vrf_id,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001229 'is_add': is_add})
Matus Fabiande886752016-12-07 03:38:19 -08001230
Matus Fabian2ba92e32017-08-21 07:05:03 -07001231 def nat44_address_dump(self):
1232 """Dump NAT44 addresses
1233 :return: Dictionary of NAT44 addresses
Matus Fabiande886752016-12-07 03:38:19 -08001234 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001235 return self.api(self.papi.nat44_address_dump, {})
Matus Fabiande886752016-12-07 03:38:19 -08001236
Matus Fabian2ba92e32017-08-21 07:05:03 -07001237 def nat44_interface_dump(self):
1238 """Dump interfaces with NAT44 feature
1239 :return: Dictionary of interfaces with NAT44 feature
Matus Fabiande886752016-12-07 03:38:19 -08001240 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001241 return self.api(self.papi.nat44_interface_dump, {})
Matus Fabiande886752016-12-07 03:38:19 -08001242
Matus Fabian2ba92e32017-08-21 07:05:03 -07001243 def nat44_interface_output_feature_dump(self):
1244 """Dump interfaces with NAT44 output feature
1245 :return: Dictionary of interfaces with NAT44 output feature
Matus Fabian93d84c92017-07-19 08:06:01 -07001246 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001247 return self.api(self.papi.nat44_interface_output_feature_dump, {})
Matus Fabian93d84c92017-07-19 08:06:01 -07001248
Matus Fabian2ba92e32017-08-21 07:05:03 -07001249 def nat44_static_mapping_dump(self):
1250 """Dump NAT44 static mappings
1251 :return: Dictionary of NAT44 static mappings
Matus Fabiande886752016-12-07 03:38:19 -08001252 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001253 return self.api(self.papi.nat44_static_mapping_dump, {})
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001254
Matus Fabian2ba92e32017-08-21 07:05:03 -07001255 def nat_show_config(self):
1256 """Show NAT plugin config
1257 :return: NAT plugin config parameters
Matus Fabian9902fcd2016-12-21 23:58:46 -08001258 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001259 return self.api(self.papi.nat_show_config, {})
Matus Fabian9902fcd2016-12-21 23:58:46 -08001260
Matus Fabian2ba92e32017-08-21 07:05:03 -07001261 def nat44_add_interface_addr(
Matus Fabian8bf68e82017-01-12 04:24:35 -08001262 self,
1263 sw_if_index,
1264 is_add=1):
Matus Fabian2ba92e32017-08-21 07:05:03 -07001265 """Add/del NAT44 address from interface
Matus Fabian8bf68e82017-01-12 04:24:35 -08001266
1267 :param sw_if_index: Software index of the interface
1268 :param is_add: 1 if add, 0 if delete (Default value = 1)
1269 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001270 return self.api(self.papi.nat44_add_del_interface_addr,
Matus Fabian8bf68e82017-01-12 04:24:35 -08001271 {'is_add': is_add, 'sw_if_index': sw_if_index})
1272
Matus Fabian2ba92e32017-08-21 07:05:03 -07001273 def nat44_interface_addr_dump(self):
1274 """Dump NAT44 addresses interfaces
1275 :return: Dictionary of NAT44 addresses interfaces
Matus Fabian8bf68e82017-01-12 04:24:35 -08001276 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001277 return self.api(self.papi.nat44_interface_addr_dump, {})
Matus Fabian8bf68e82017-01-12 04:24:35 -08001278
Matus Fabian2ba92e32017-08-21 07:05:03 -07001279 def nat_ipfix(
Matus Fabianeea28d72017-01-13 04:15:54 -08001280 self,
1281 domain_id=1,
1282 src_port=4739,
1283 enable=1):
Matus Fabian2ba92e32017-08-21 07:05:03 -07001284 """Enable/disable NAT IPFIX logging
Matus Fabianeea28d72017-01-13 04:15:54 -08001285
1286 :param domain_id: Observation domain ID (Default value = 1)
1287 :param src_port: Source port number (Default value = 4739)
1288 :param enable: 1 if enable, 0 if disable (Default value = 1)
1289 """
1290 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001291 self.papi.nat_ipfix_enable_disable,
Matus Fabianeea28d72017-01-13 04:15:54 -08001292 {'domain_id': domain_id,
1293 'src_port': src_port,
1294 'enable': enable})
1295
Matus Fabian2ba92e32017-08-21 07:05:03 -07001296 def nat44_user_session_dump(
magalik23caa882017-02-08 23:25:45 -08001297 self,
1298 ip_address,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001299 vrf_id):
1300 """Dump NAT44 user's sessions
magalik23caa882017-02-08 23:25:45 -08001301
1302 :param ip_address: ip adress of the user to be dumped
1303 :param cpu_index: cpu_index on which the user is
1304 :param vrf_id: VRF ID
1305 :return: Dictionary of S-NAT sessions
1306 """
1307 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001308 self.papi.nat44_user_session_dump,
magalik23caa882017-02-08 23:25:45 -08001309 {'ip_address': ip_address,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001310 'vrf_id': vrf_id})
magalik23caa882017-02-08 23:25:45 -08001311
Matus Fabian2ba92e32017-08-21 07:05:03 -07001312 def nat44_user_dump(self):
1313 """Dump NAT44 users
magalik23caa882017-02-08 23:25:45 -08001314
Matus Fabian2ba92e32017-08-21 07:05:03 -07001315 :return: Dictionary of NAT44 users
magalik23caa882017-02-08 23:25:45 -08001316 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001317 return self.api(self.papi.nat44_user_dump, {})
magalik23caa882017-02-08 23:25:45 -08001318
Matus Fabian704018c2017-09-04 02:17:18 -07001319 def nat44_add_del_lb_static_mapping(
1320 self,
1321 external_addr,
1322 external_port,
1323 protocol,
1324 vrf_id=0,
1325 local_num=0,
1326 locals=None,
1327 is_add=1):
1328 """Add/delete NAT44 load balancing static mapping
1329
1330 :param is_add - 1 if add, 0 if delete
1331 """
1332 return self.api(
1333 self.papi.nat44_add_del_lb_static_mapping,
1334 {'is_add': is_add,
1335 'external_addr': external_addr,
1336 'external_port': external_port,
1337 'protocol': protocol,
1338 'vrf_id': vrf_id,
1339 'local_num': local_num,
1340 'locals': locals})
1341
1342 def nat44_lb_static_mapping_dump(self):
1343 """Dump NAT44 load balancing static mappings
1344
1345 :return: Dictionary of NAT44 load balancing static mapping
1346 """
1347 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1348
Matus Fabian2ba92e32017-08-21 07:05:03 -07001349 def nat_det_add_del_map(
Matus Fabian066f0342017-02-10 03:48:01 -08001350 self,
1351 in_addr,
1352 in_plen,
1353 out_addr,
1354 out_plen,
1355 is_add=1):
Matus Fabian2ba92e32017-08-21 07:05:03 -07001356 """Add/delete deterministic NAT mapping
Matus Fabian066f0342017-02-10 03:48:01 -08001357
1358 :param is_add - 1 if add, 0 if delete
1359 :param in_addr - inside IP address
1360 :param in_plen - inside IP address prefix length
1361 :param out_addr - outside IP address
1362 :param out_plen - outside IP address prefix length
1363 """
1364 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001365 self.papi.nat_det_add_del_map,
Matus Fabian066f0342017-02-10 03:48:01 -08001366 {'is_add': is_add,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001367 'is_nat44': 1,
Matus Fabian066f0342017-02-10 03:48:01 -08001368 'in_addr': in_addr,
1369 'in_plen': in_plen,
1370 'out_addr': out_addr,
1371 'out_plen': out_plen})
1372
Matus Fabian2ba92e32017-08-21 07:05:03 -07001373 def nat_det_forward(
Matus Fabian066f0342017-02-10 03:48:01 -08001374 self,
1375 in_addr):
1376 """Get outside address and port range from inside address
1377
1378 :param in_addr - inside IP address
1379 """
1380 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001381 self.papi.nat_det_forward,
1382 {'in_addr': in_addr,
1383 'is_nat44': 1})
Matus Fabian066f0342017-02-10 03:48:01 -08001384
Matus Fabian2ba92e32017-08-21 07:05:03 -07001385 def nat_det_reverse(
Matus Fabian066f0342017-02-10 03:48:01 -08001386 self,
1387 out_addr,
1388 out_port):
1389 """Get inside address from outside address and port
1390
1391 :param out_addr - outside IP address
1392 :param out_port - outside port
1393 """
1394 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001395 self.papi.nat_det_reverse,
Matus Fabian066f0342017-02-10 03:48:01 -08001396 {'out_addr': out_addr,
1397 'out_port': out_port})
1398
Matus Fabian2ba92e32017-08-21 07:05:03 -07001399 def nat_det_map_dump(self):
1400 """Dump deterministic NAT mappings
Martin17a75cb2017-03-08 05:53:20 -08001401
Matus Fabian2ba92e32017-08-21 07:05:03 -07001402 :return: Dictionary of deterministic NAT mappings
Martin17a75cb2017-03-08 05:53:20 -08001403 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001404 return self.api(self.papi.nat_det_map_dump, {})
Martin17a75cb2017-03-08 05:53:20 -08001405
Matus Fabian2ba92e32017-08-21 07:05:03 -07001406 def nat_det_set_timeouts(
Matus Fabian6a0946f2017-04-12 03:36:13 -07001407 self,
1408 udp=300,
1409 tcp_established=7440,
1410 tcp_transitory=240,
1411 icmp=60):
1412 """Set values of timeouts for deterministic NAT (in seconds)
1413
1414 :param udp - UDP timeout (Default value = 300)
1415 :param tcp_established - TCP established timeout (Default value = 7440)
1416 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1417 :param icmp - ICMP timeout (Default value = 60)
1418 """
1419 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001420 self.papi.nat_det_set_timeouts,
Matus Fabian6a0946f2017-04-12 03:36:13 -07001421 {'udp': udp,
1422 'tcp_established': tcp_established,
1423 'tcp_transitory': tcp_transitory,
1424 'icmp': icmp})
1425
Matus Fabian2ba92e32017-08-21 07:05:03 -07001426 def nat_det_get_timeouts(self):
Matus Fabian6a0946f2017-04-12 03:36:13 -07001427 """Get values of timeouts for deterministic NAT
1428
1429 :return: Timeouts for deterministic NAT (in seconds)
1430 """
Matus Fabian2ba92e32017-08-21 07:05:03 -07001431 return self.api(self.papi.nat_det_get_timeouts, {})
Matus Fabian6a0946f2017-04-12 03:36:13 -07001432
Matus Fabian2ba92e32017-08-21 07:05:03 -07001433 def nat_det_close_session_out(
Martin Gálik6bc8c642017-04-19 01:12:27 -07001434 self,
1435 out_addr,
1436 out_port,
1437 ext_addr,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001438 ext_port):
1439 """Close deterministic NAT session using outside address and port
Martin Gálik6bc8c642017-04-19 01:12:27 -07001440
1441 :param out_addr - outside IP address
1442 :param out_port - outside port
1443 :param ext_addr - external host IP address
1444 :param ext_port - external host port
Martin Gálik6bc8c642017-04-19 01:12:27 -07001445 """
1446 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001447 self.papi.nat_det_close_session_out,
Martin Gálik6bc8c642017-04-19 01:12:27 -07001448 {'out_addr': out_addr,
1449 'out_port': out_port,
1450 'ext_addr': ext_addr,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001451 'ext_port': ext_port})
Martin Gálik6bc8c642017-04-19 01:12:27 -07001452
Matus Fabian2ba92e32017-08-21 07:05:03 -07001453 def nat_det_close_session_in(
Martin Gálik6bc8c642017-04-19 01:12:27 -07001454 self,
1455 in_addr,
1456 in_port,
1457 ext_addr,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001458 ext_port):
1459 """Close deterministic NAT session using inside address and port
Martin Gálik6bc8c642017-04-19 01:12:27 -07001460
1461 :param in_addr - inside IP address
1462 :param in_port - inside port
1463 :param ext_addr - external host IP address
1464 :param ext_port - external host port
Martin Gálik6bc8c642017-04-19 01:12:27 -07001465 """
1466 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001467 self.papi.nat_det_close_session_in,
Martin Gálik6bc8c642017-04-19 01:12:27 -07001468 {'in_addr': in_addr,
1469 'in_port': in_port,
1470 'ext_addr': ext_addr,
1471 'ext_port': ext_port,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001472 'is_nat44': 1})
Martin Gálik6bc8c642017-04-19 01:12:27 -07001473
Matus Fabian2ba92e32017-08-21 07:05:03 -07001474 def nat_det_session_dump(
Martin Gálik9806eae2017-04-25 01:25:08 -07001475 self,
Matus Fabian2ba92e32017-08-21 07:05:03 -07001476 user_addr):
1477 """Dump deterministic NAT sessions belonging to a user
Martin Gálik9806eae2017-04-25 01:25:08 -07001478
1479 :param user_addr - inside IP address of the user
Matus Fabian2ba92e32017-08-21 07:05:03 -07001480 :return: Dictionary of deterministic NAT sessions
Martin Gálik9806eae2017-04-25 01:25:08 -07001481 """
1482 return self.api(
Matus Fabian2ba92e32017-08-21 07:05:03 -07001483 self.papi.nat_det_session_dump,
1484 {'is_nat44': 1,
Martin Gálik9806eae2017-04-25 01:25:08 -07001485 'user_addr': user_addr})
1486
Matus Fabian06596c52017-06-06 04:53:28 -07001487 def nat64_add_del_pool_addr_range(
1488 self,
1489 start_addr,
1490 end_addr,
1491 vrf_id=0xFFFFFFFF,
1492 is_add=1):
1493 """Add/del address range to NAT64 pool
1494
1495 :param start_addr: First IP address
1496 :param end_addr: Last IP address
1497 :param vrf_id: VRF id for the address range
1498 :param is_add: 1 if add, 0 if delete (Default value = 1)
1499 """
1500 return self.api(
1501 self.papi.nat64_add_del_pool_addr_range,
1502 {'start_addr': start_addr,
1503 'end_addr': end_addr,
1504 'vrf_id': vrf_id,
1505 'is_add': is_add})
1506
1507 def nat64_pool_addr_dump(self):
1508 """Dump NAT64 pool addresses
1509 :return: Dictionary of NAT64 pool addresses
1510 """
1511 return self.api(self.papi.nat64_pool_addr_dump, {})
1512
1513 def nat64_add_del_interface(
1514 self,
1515 sw_if_index,
1516 is_inside=1,
1517 is_add=1):
1518 """Enable/disable NAT64 feature on the interface
1519 :param sw_if_index: Index of the interface
1520 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1521 :param is_add: 1 if add, 0 if delete (Default value = 1)
1522 """
1523 return self.api(
1524 self.papi.nat64_add_del_interface,
1525 {'sw_if_index': sw_if_index,
1526 'is_inside': is_inside,
1527 'is_add': is_add})
1528
1529 def nat64_interface_dump(self):
1530 """Dump interfaces with NAT64 feature
1531 :return: Dictionary of interfaces with NAT64 feature
1532 """
1533 return self.api(self.papi.nat64_interface_dump, {})
1534
1535 def nat64_add_del_static_bib(
1536 self,
1537 in_ip,
1538 out_ip,
1539 in_port,
1540 out_port,
1541 protocol,
1542 vrf_id=0,
1543 is_add=1):
1544 """Add/delete S-NAT static BIB entry
1545
1546 :param in_ip: Inside IPv6 address
1547 :param out_ip: Outside IPv4 address
1548 :param in_port: Inside port number
1549 :param out_port: Outside port number
1550 :param protocol: IP protocol
1551 :param vrf_id: VRF ID (Default value = 0)
1552 :param is_add: 1 if add, 0 if delete (Default value = 1)
1553 """
1554 return self.api(
1555 self.papi.nat64_add_del_static_bib,
1556 {'i_addr': in_ip,
1557 'o_addr': out_ip,
1558 'i_port': in_port,
1559 'o_port': out_port,
1560 'vrf_id': vrf_id,
1561 'proto': protocol,
1562 'is_add': is_add})
1563
Matus Fabianab9a59c2017-08-16 05:37:36 -07001564 def nat64_bib_dump(self, protocol=255):
Matus Fabian06596c52017-06-06 04:53:28 -07001565 """Dump NAT64 BIB
1566
Matus Fabianab9a59c2017-08-16 05:37:36 -07001567 :param protocol: IP protocol (Default value = 255, all BIBs)
Matus Fabian06596c52017-06-06 04:53:28 -07001568 :returns: Dictionary of NAT64 BIB entries
1569 """
1570 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1571
1572 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1573 tcp_incoming_syn=6):
1574 """Set values of timeouts for NAT64 (in seconds)
1575
Matus Fabian428dc912017-06-21 06:15:18 -07001576 :param udpi: UDP timeout (Default value = 300)
1577 :param icmp: ICMP timeout (Default value = 60)
1578 :param tcp_trans: TCP transitory timeout (Default value = 240)
1579 :param tcp_est: TCP established timeout (Default value = 7440)
1580 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
Matus Fabian06596c52017-06-06 04:53:28 -07001581 """
1582 return self.api(
1583 self.papi.nat64_set_timeouts,
1584 {'udp': udp,
1585 'icmp': icmp,
1586 'tcp_trans': tcp_trans,
1587 'tcp_est': tcp_est,
1588 'tcp_incoming_syn': tcp_incoming_syn})
1589
1590 def nat64_get_timeouts(self):
1591 """Get values of timeouts for NAT64
1592
1593 :return: Timeouts for NAT64 (in seconds)
1594 """
1595 return self.api(self.papi.nat64_get_timeouts, {})
1596
Matus Fabianab9a59c2017-08-16 05:37:36 -07001597 def nat64_st_dump(self, protocol=255):
Matus Fabian06596c52017-06-06 04:53:28 -07001598 """Dump NAT64 session table
1599
Matus Fabianab9a59c2017-08-16 05:37:36 -07001600 :param protocol: IP protocol (Default value = 255, all STs)
Matus Fabian06596c52017-06-06 04:53:28 -07001601 :returns: Dictionary of NAT64 sesstion table entries
1602 """
1603 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1604
Matus Fabian428dc912017-06-21 06:15:18 -07001605 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1606 """Add/del NAT64 prefix
1607
1608 :param prefix: NAT64 prefix
1609 :param plen: NAT64 prefix length
1610 :param vrf_id: VRF id of tenant (Default 0)
1611 :param is_add: 1 if add, 0 if delete (Default value = 1)
1612 """
1613 return self.api(
1614 self.papi.nat64_add_del_prefix,
1615 {'prefix': prefix,
1616 'prefix_len': plen,
1617 'vrf_id': vrf_id,
1618 'is_add': is_add})
1619
1620 def nat64_prefix_dump(self):
1621 """Dump NAT64 prefix
1622
1623 :returns: Dictionary of NAT64 prefixes
1624 """
1625 return self.api(self.papi.nat64_prefix_dump, {})
1626
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001627 def control_ping(self):
1628 self.api(self.papi.control_ping)
1629
1630 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
Klement Sekerab17dd962017-01-09 07:43:48 +01001631 detect_mult, local_addr, peer_addr, is_ipv6=0,
1632 bfd_key_id=None, conf_key_id=None):
1633 if bfd_key_id is None:
1634 return self.api(self.papi.bfd_udp_add,
1635 {
1636 'sw_if_index': sw_if_index,
1637 'desired_min_tx': desired_min_tx,
1638 'required_min_rx': required_min_rx,
1639 'local_addr': local_addr,
1640 'peer_addr': peer_addr,
1641 'is_ipv6': is_ipv6,
1642 'detect_mult': detect_mult,
1643 })
1644 else:
1645 return self.api(self.papi.bfd_udp_add,
1646 {
1647 'sw_if_index': sw_if_index,
1648 'desired_min_tx': desired_min_tx,
1649 'required_min_rx': required_min_rx,
1650 'local_addr': local_addr,
1651 'peer_addr': peer_addr,
1652 'is_ipv6': is_ipv6,
1653 'detect_mult': detect_mult,
1654 'is_authenticated': 1,
1655 'bfd_key_id': bfd_key_id,
1656 'conf_key_id': conf_key_id,
1657 })
1658
Klement Sekeraa57a9702017-02-02 06:58:07 +01001659 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1660 detect_mult, local_addr, peer_addr, is_ipv6=0):
1661 return self.api(self.papi.bfd_udp_mod,
1662 {
1663 'sw_if_index': sw_if_index,
1664 'desired_min_tx': desired_min_tx,
1665 'required_min_rx': required_min_rx,
1666 'local_addr': local_addr,
1667 'peer_addr': peer_addr,
1668 'is_ipv6': is_ipv6,
1669 'detect_mult': detect_mult,
1670 })
1671
Klement Sekerab17dd962017-01-09 07:43:48 +01001672 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1673 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1674 is_delayed=False):
1675 return self.api(self.papi.bfd_udp_auth_activate,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001676 {
1677 'sw_if_index': sw_if_index,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001678 'local_addr': local_addr,
1679 'peer_addr': peer_addr,
1680 'is_ipv6': is_ipv6,
Klement Sekerab17dd962017-01-09 07:43:48 +01001681 'is_delayed': 1 if is_delayed else 0,
1682 'bfd_key_id': bfd_key_id,
1683 'conf_key_id': conf_key_id,
1684 })
1685
1686 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1687 is_ipv6=0, is_delayed=False):
1688 return self.api(self.papi.bfd_udp_auth_deactivate,
1689 {
1690 'sw_if_index': sw_if_index,
1691 'local_addr': local_addr,
1692 'peer_addr': peer_addr,
1693 'is_ipv6': is_ipv6,
1694 'is_delayed': 1 if is_delayed else 0,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001695 })
1696
1697 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1698 return self.api(self.papi.bfd_udp_del,
1699 {
1700 'sw_if_index': sw_if_index,
1701 'local_addr': local_addr,
1702 'peer_addr': peer_addr,
1703 'is_ipv6': is_ipv6,
1704 })
1705
1706 def bfd_udp_session_dump(self):
1707 return self.api(self.papi.bfd_udp_session_dump, {})
1708
Klement Sekerab17dd962017-01-09 07:43:48 +01001709 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1710 peer_addr, is_ipv6=0):
1711 return self.api(self.papi.bfd_udp_session_set_flags, {
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001712 'admin_up_down': admin_up_down,
Klement Sekerab17dd962017-01-09 07:43:48 +01001713 'sw_if_index': sw_if_index,
1714 'local_addr': local_addr,
1715 'peer_addr': peer_addr,
1716 'is_ipv6': is_ipv6,
Klement Sekera0e3c0de2016-09-29 14:43:44 +02001717 })
1718
1719 def want_bfd_events(self, enable_disable=1):
1720 return self.api(self.papi.want_bfd_events, {
1721 'enable_disable': enable_disable,
1722 'pid': os.getpid(),
1723 })
Steve Shin7957d6e2016-12-19 09:24:50 -08001724
Klement Sekerab17dd962017-01-09 07:43:48 +01001725 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1726 return self.api(self.papi.bfd_auth_set_key, {
1727 'conf_key_id': conf_key_id,
1728 'auth_type': auth_type,
1729 'key': key,
1730 'key_len': len(key),
1731 })
1732
1733 def bfd_auth_del_key(self, conf_key_id):
1734 return self.api(self.papi.bfd_auth_del_key, {
1735 'conf_key_id': conf_key_id,
1736 })
1737
1738 def bfd_auth_keys_dump(self):
1739 return self.api(self.papi.bfd_auth_keys_dump, {})
1740
Klement Sekera239790f2017-02-16 10:53:53 +01001741 def bfd_udp_set_echo_source(self, sw_if_index):
1742 return self.api(self.papi.bfd_udp_set_echo_source,
1743 {'sw_if_index': sw_if_index})
1744
Klement Sekera73884482017-02-23 09:26:30 +01001745 def bfd_udp_del_echo_source(self):
1746 return self.api(self.papi.bfd_udp_del_echo_source, {})
1747
Steve Shin7957d6e2016-12-19 09:24:50 -08001748 def classify_add_del_table(
1749 self,
1750 is_add,
1751 mask,
1752 match_n_vectors=1,
1753 table_index=0xFFFFFFFF,
1754 nbuckets=2,
1755 memory_size=2097152,
1756 skip_n_vectors=0,
1757 next_table_index=0xFFFFFFFF,
1758 miss_next_index=0xFFFFFFFF,
1759 current_data_flag=0,
1760 current_data_offset=0):
Steve Shin7957d6e2016-12-19 09:24:50 -08001761 """
1762 :param is_add:
1763 :param mask:
Klement Sekerada505f62017-01-04 12:58:53 +01001764 :param match_n_vectors: (Default value = 1)
Matej Klotton8d8a1da2016-12-22 11:06:56 +01001765 :param table_index: (Default value = 0xFFFFFFFF)
Steve Shin7957d6e2016-12-19 09:24:50 -08001766 :param nbuckets: (Default value = 2)
1767 :param memory_size: (Default value = 2097152)
1768 :param skip_n_vectors: (Default value = 0)
1769 :param next_table_index: (Default value = 0xFFFFFFFF)
1770 :param miss_next_index: (Default value = 0xFFFFFFFF)
1771 :param current_data_flag: (Default value = 0)
1772 :param current_data_offset: (Default value = 0)
1773 """
1774
1775 return self.api(
1776 self.papi.classify_add_del_table,
Klement Sekera77fabdb2017-01-02 07:46:14 +01001777 {'is_add': is_add,
1778 'table_index': table_index,
1779 'nbuckets': nbuckets,
Steve Shin7957d6e2016-12-19 09:24:50 -08001780 'memory_size': memory_size,
Klement Sekera77fabdb2017-01-02 07:46:14 +01001781 'skip_n_vectors': skip_n_vectors,
1782 'match_n_vectors': match_n_vectors,
1783 'next_table_index': next_table_index,
1784 'miss_next_index': miss_next_index,
1785 'current_data_flag': current_data_flag,
1786 'current_data_offset': current_data_offset,
1787 'mask': mask})
Steve Shin7957d6e2016-12-19 09:24:50 -08001788
1789 def classify_add_del_session(
1790 self,
1791 is_add,
1792 table_index,
1793 match,
1794 opaque_index=0xFFFFFFFF,
1795 hit_next_index=0xFFFFFFFF,
1796 advance=0,
1797 action=0,
1798 metadata=0):
1799 """
1800 :param is_add:
1801 :param table_index:
1802 :param match:
1803 :param opaque_index: (Default value = 0xFFFFFFFF)
1804 :param hit_next_index: (Default value = 0xFFFFFFFF)
1805 :param advance: (Default value = 0)
1806 :param action: (Default value = 0)
1807 :param metadata: (Default value = 0)
1808 """
1809
1810 return self.api(
1811 self.papi.classify_add_del_session,
Klement Sekera77fabdb2017-01-02 07:46:14 +01001812 {'is_add': is_add,
1813 'table_index': table_index,
1814 'hit_next_index': hit_next_index,
1815 'opaque_index': opaque_index,
1816 'advance': advance,
1817 'action': action,
1818 'metadata': metadata,
1819 'match': match})
Steve Shin7957d6e2016-12-19 09:24:50 -08001820
1821 def input_acl_set_interface(
1822 self,
1823 is_add,
1824 sw_if_index,
1825 ip4_table_index=0xFFFFFFFF,
1826 ip6_table_index=0xFFFFFFFF,
1827 l2_table_index=0xFFFFFFFF):
1828 """
1829 :param is_add:
1830 :param sw_if_index:
1831 :param ip4_table_index: (Default value = 0xFFFFFFFF)
1832 :param ip6_table_index: (Default value = 0xFFFFFFFF)
1833 :param l2_table_index: (Default value = 0xFFFFFFFF)
1834 """
1835
1836 return self.api(
1837 self.papi.input_acl_set_interface,
Klement Sekera77fabdb2017-01-02 07:46:14 +01001838 {'sw_if_index': sw_if_index,
1839 'ip4_table_index': ip4_table_index,
1840 'ip6_table_index': ip6_table_index,
1841 'l2_table_index': l2_table_index,
1842 'is_add': is_add})
1843
1844 def set_ipfix_exporter(
1845 self,
1846 collector_address,
1847 src_address,
1848 path_mtu,
1849 template_interval,
1850 vrf_id=0,
1851 collector_port=4739,
1852 udp_checksum=0):
1853 return self.api(
1854 self.papi.set_ipfix_exporter,
1855 {
1856 'collector_address': collector_address,
1857 'collector_port': collector_port,
1858 'src_address': src_address,
1859 'vrf_id': vrf_id,
1860 'path_mtu': path_mtu,
1861 'template_interval': template_interval,
1862 'udp_checksum': udp_checksum,
1863 })
Neale Rannsfca0c242017-01-13 07:57:46 -08001864
1865 def dhcp_proxy_config(self,
1866 dhcp_server,
1867 dhcp_src_address,
1868 rx_table_id=0,
1869 server_table_id=0,
1870 is_add=1,
Neale Ranns20a175a2017-02-14 07:28:41 -08001871 is_ipv6=0):
Neale Rannsfca0c242017-01-13 07:57:46 -08001872 return self.api(
Neale Ranns20a175a2017-02-14 07:28:41 -08001873 self.papi.dhcp_proxy_config,
Neale Rannsfca0c242017-01-13 07:57:46 -08001874 {
1875 'rx_vrf_id': rx_table_id,
1876 'server_vrf_id': server_table_id,
1877 'is_ipv6': is_ipv6,
1878 'is_add': is_add,
Neale Rannsfca0c242017-01-13 07:57:46 -08001879 'dhcp_server': dhcp_server,
1880 'dhcp_src_address': dhcp_src_address,
1881 })
1882
1883 def dhcp_proxy_set_vss(self,
1884 table_id,
1885 fib_id,
1886 oui,
1887 is_add=1,
1888 is_ip6=0):
1889 return self.api(
1890 self.papi.dhcp_proxy_set_vss,
1891 {
1892 'tbl_id': table_id,
1893 'fib_id': fib_id,
1894 'is_ipv6': is_ip6,
1895 'is_add': is_add,
1896 'oui': oui,
1897 })
Neale Ranns32e1c012016-11-22 17:07:28 +00001898
Neale Rannsa2fbf6b2017-07-18 08:23:32 -07001899 def dhcp_client(self,
1900 sw_if_index,
1901 hostname,
Neale Ranns51822bf2017-07-18 09:26:53 -07001902 client_id='',
Neale Rannsa2fbf6b2017-07-18 08:23:32 -07001903 is_add=1,
1904 want_dhcp_events=0):
1905 return self.api(
1906 self.papi.dhcp_client_config,
1907 {
1908 'sw_if_index': sw_if_index,
1909 'hostname': hostname,
Neale Ranns51822bf2017-07-18 09:26:53 -07001910 'client_id': client_id,
Neale Rannsa2fbf6b2017-07-18 08:23:32 -07001911 'is_add': is_add,
1912 'want_dhcp_event': want_dhcp_events,
1913 'pid': os.getpid(),
1914 })
1915
Neale Ranns32e1c012016-11-22 17:07:28 +00001916 def ip_mroute_add_del(self,
1917 src_address,
1918 grp_address,
1919 grp_address_length,
1920 e_flags,
1921 next_hop_sw_if_index,
1922 i_flags,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001923 rpf_id=0,
Neale Ranns32e1c012016-11-22 17:07:28 +00001924 table_id=0,
Neale Ranns32e1c012016-11-22 17:07:28 +00001925 is_add=1,
1926 is_ipv6=0,
1927 is_local=0):
1928 """
1929 """
1930 return self.api(
1931 self.papi.ip_mroute_add_del,
1932 {'next_hop_sw_if_index': next_hop_sw_if_index,
1933 'entry_flags': e_flags,
1934 'itf_flags': i_flags,
Neale Ranns0f26c5a2017-03-01 15:12:11 -08001935 'table_id': table_id,
1936 'rpf_id': rpf_id,
Neale Ranns32e1c012016-11-22 17:07:28 +00001937 'is_add': is_add,
1938 'is_ipv6': is_ipv6,
1939 'is_local': is_local,
1940 'grp_address_length': grp_address_length,
1941 'grp_address': grp_address,
1942 'src_address': src_address})
1943
1944 def mfib_signal_dump(self):
1945 return self.api(self.papi.mfib_signal_dump, {})
Neale Ranns5a8123b2017-01-26 01:18:23 -08001946
1947 def ip_mfib_dump(self):
1948 return self.api(self.papi.ip_mfib_dump, {})
Filip Tehlar770e89e2017-01-31 10:39:16 +01001949
1950 def lisp_enable_disable(self, is_enabled):
1951 return self.api(
1952 self.papi.lisp_enable_disable,
1953 {
1954 'is_en': is_enabled,
1955 })
1956
1957 def lisp_locator_set(self,
1958 ls_name,
1959 is_add=1):
1960 return self.api(
1961 self.papi.lisp_add_del_locator_set,
1962 {
1963 'is_add': is_add,
1964 'locator_set_name': ls_name
1965 })
1966
1967 def lisp_locator_set_dump(self):
1968 return self.api(self.papi.lisp_locator_set_dump, {})
1969
1970 def lisp_locator(self,
1971 ls_name,
1972 sw_if_index,
1973 priority=1,
1974 weight=1,
1975 is_add=1):
1976 return self.api(
1977 self.papi.lisp_add_del_locator,
1978 {
1979 'is_add': is_add,
1980 'locator_set_name': ls_name,
1981 'sw_if_index': sw_if_index,
1982 'priority': priority,
1983 'weight': weight
1984 })
1985
1986 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
1987 return self.api(
1988 self.papi.lisp_locator_dump,
1989 {
1990 'is_index_set': is_index_set,
1991 'ls_name': ls_name,
1992 'ls_index': ls_index,
1993 })
1994
1995 def lisp_local_mapping(self,
1996 ls_name,
1997 eid_type,
1998 eid,
1999 prefix_len,
2000 vni=0,
2001 key_id=0,
2002 key="",
2003 is_add=1):
2004 return self.api(
2005 self.papi.lisp_add_del_local_eid,
2006 {
2007 'locator_set_name': ls_name,
2008 'is_add': is_add,
2009 'eid_type': eid_type,
2010 'eid': eid,
2011 'prefix_len': prefix_len,
2012 'vni': vni,
2013 'key_id': key_id,
2014 'key': key
2015 })
2016
2017 def lisp_eid_table_dump(self,
2018 eid_set=0,
2019 prefix_length=0,
2020 vni=0,
2021 eid_type=0,
2022 eid=None,
2023 filter_opt=0):
2024 return self.api(
2025 self.papi.lisp_eid_table_dump,
2026 {
2027 'eid_set': eid_set,
2028 'prefix_length': prefix_length,
2029 'vni': vni,
2030 'eid_type': eid_type,
2031 'eid': eid,
2032 'filter': filter_opt,
2033 })
2034
2035 def lisp_remote_mapping(self,
2036 eid_type,
2037 eid,
2038 eid_prefix_len=0,
2039 vni=0,
2040 rlocs=None,
2041 rlocs_num=0,
2042 is_src_dst=0,
2043 is_add=1):
2044 return self.api(
2045 self.papi.lisp_add_del_remote_mapping,
2046 {
2047 'is_add': is_add,
2048 'eid_type': eid_type,
2049 'eid': eid,
2050 'eid_len': eid_prefix_len,
2051 'rloc_num': rlocs_num,
2052 'rlocs': rlocs,
2053 'vni': vni,
2054 'is_src_dst': is_src_dst,
2055 })
2056
2057 def lisp_adjacency(self,
2058 leid,
2059 reid,
2060 leid_len,
2061 reid_len,
2062 eid_type,
2063 is_add=1,
2064 vni=0):
2065 return self.api(
2066 self.papi.lisp_add_del_adjacency,
2067 {
2068 'is_add': is_add,
2069 'vni': vni,
2070 'eid_type': eid_type,
2071 'leid': leid,
2072 'reid': reid,
2073 'leid_len': leid_len,
2074 'reid_len': reid_len,
2075 })
2076
2077 def lisp_adjacencies_get(self, vni=0):
2078 return self.api(
2079 self.papi.lisp_adjacencies_get,
2080 {
2081 'vni': vni
2082 })
Neale Ranns80823802017-02-20 18:23:41 -08002083
2084 def map_add_domain(self,
2085 ip6_prefix,
2086 ip6_prefix_len,
2087 ip6_src,
2088 ip6_src_prefix_len,
2089 ip4_prefix,
2090 ip4_prefix_len,
2091 ea_bits_len=0,
2092 psid_offset=0,
2093 psid_length=0,
2094 is_translation=0,
2095 mtu=1280):
2096 return self.api(
2097 self.papi.map_add_domain,
2098 {
2099 'ip6_prefix': ip6_prefix,
2100 'ip6_prefix_len': ip6_prefix_len,
2101 'ip4_prefix': ip4_prefix,
2102 'ip4_prefix_len': ip4_prefix_len,
2103 'ip6_src': ip6_src,
2104 'ip6_src_prefix_len': ip6_src_prefix_len,
2105 'ea_bits_len': ea_bits_len,
2106 'psid_offset': psid_offset,
2107 'psid_length': psid_length,
2108 'is_translation': is_translation,
2109 'mtu': mtu
2110 })
Hongjun Nief486b12017-04-12 19:21:16 +08002111
2112 def gtpu_add_del_tunnel(
2113 self,
2114 src_addr,
2115 dst_addr,
2116 is_add=1,
2117 is_ipv6=0,
2118 mcast_sw_if_index=0xFFFFFFFF,
2119 encap_vrf_id=0,
2120 decap_next_index=0xFFFFFFFF,
2121 teid=0):
2122 """
2123
2124 :param is_add: (Default value = 1)
2125 :param is_ipv6: (Default value = 0)
2126 :param src_addr:
2127 :param dst_addr:
2128 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2129 :param encap_vrf_id: (Default value = 0)
2130 :param decap_next_index: (Default value = 0xFFFFFFFF)
2131 :param teid: (Default value = 0)
2132
2133 """
2134 return self.api(self.papi.gtpu_add_del_tunnel,
2135 {'is_add': is_add,
2136 'is_ipv6': is_ipv6,
2137 'src_address': src_addr,
2138 'dst_address': dst_addr,
2139 'mcast_sw_if_index': mcast_sw_if_index,
2140 'encap_vrf_id': encap_vrf_id,
2141 'decap_next_index': decap_next_index,
2142 'teid': teid})
Hongjun Ni8a0a0ae2017-05-27 20:23:09 +08002143
2144 def vxlan_gpe_add_del_tunnel(
2145 self,
2146 src_addr,
2147 dst_addr,
2148 mcast_sw_if_index=0xFFFFFFFF,
2149 is_add=1,
2150 is_ipv6=0,
2151 encap_vrf_id=0,
2152 decap_vrf_id=0,
2153 protocol=3,
2154 vni=0):
2155 """
2156
2157 :param local:
2158 :param remote:
2159 :param is_add: (Default value = 1)
2160 :param is_ipv6: (Default value = 0)
2161 :param encap_vrf_id: (Default value = 0)
2162 :param decap_vrf_id: (Default value = 0)
2163 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2164 :param protocol: (Default value = 3)
2165 :param vni: (Default value = 0)
2166
2167 """
2168 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2169 {'is_add': is_add,
2170 'is_ipv6': is_ipv6,
2171 'local': src_addr,
2172 'remote': dst_addr,
2173 'mcast_sw_if_index': mcast_sw_if_index,
2174 'encap_vrf_id': encap_vrf_id,
2175 'decap_vrf_id': decap_vrf_id,
2176 'protocol': protocol,
2177 'vni': vni})
Hongjun Ni62f9cdd2017-07-04 20:11:57 +08002178
2179 def pppoe_add_del_session(
2180 self,
2181 client_ip,
2182 client_mac,
2183 session_id=0,
2184 is_add=1,
2185 is_ipv6=0,
2186 decap_vrf_id=0):
2187 """
2188
2189 :param is_add: (Default value = 1)
2190 :param is_ipv6: (Default value = 0)
2191 :param client_ip:
2192 :param session_id: (Default value = 0)
2193 :param client_mac:
2194 :param decap_vrf_id: (Default value = 0)
2195
2196 """
2197 return self.api(self.papi.pppoe_add_del_session,
2198 {'is_add': is_add,
2199 'is_ipv6': is_ipv6,
2200 'session_id': session_id,
2201 'client_ip': client_ip,
2202 'decap_vrf_id': decap_vrf_id,
2203 'client_mac': client_mac})
Kris Michielsen91074432017-06-22 13:00:20 +02002204
2205 def sr_localsid_add_del(self,
2206 localsid_addr,
2207 behavior,
2208 nh_addr,
2209 is_del=0,
2210 end_psp=0,
2211 sw_if_index=0xFFFFFFFF,
2212 vlan_index=0,
2213 fib_table=0,
2214 ):
2215 """ Add/del IPv6 SR local-SID.
2216
2217 :param localsid_addr:
2218 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2219 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2220 :param nh_addr:
2221 :param is_del: (Default value = 0)
2222 :param end_psp: (Default value = 0)
2223 :param sw_if_index: (Default value = 0xFFFFFFFF)
2224 :param vlan_index: (Default value = 0)
2225 :param fib_table: (Default value = 0)
2226 """
2227 return self.api(
2228 self.papi.sr_localsid_add_del,
2229 {'is_del': is_del,
2230 'localsid_addr': localsid_addr,
2231 'end_psp': end_psp,
2232 'behavior': behavior,
2233 'sw_if_index': sw_if_index,
2234 'vlan_index': vlan_index,
2235 'fib_table': fib_table,
2236 'nh_addr': nh_addr
2237 }
2238 )
2239
2240 def sr_policy_add(
2241 self,
2242 bsid_addr,
2243 weight=1,
2244 is_encap=1,
2245 type=0,
2246 fib_table=0,
2247 n_segments=0,
2248 segments=[]):
2249 """
2250 :param bsid_addr: bindingSID of the SR Policy
2251 :param weight: weight of the sid list. optional. (default: 1)
2252 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2253 (default: Encap)
2254 :param type: type/behavior of the SR policy. (default or spray) \
2255 (default: default)
2256 :param fib_table: VRF where to install the FIB entry for the BSID \
2257 (default: 0)
2258 :param n_segments: number of segments \
2259 (default: 0)
2260 :param segments: a vector of IPv6 address composing the segment list \
2261 (default: [])
2262 """
2263 return self.api(
2264 self.papi.sr_policy_add,
2265 {'bsid_addr': bsid_addr,
2266 'weight': weight,
2267 'is_encap': is_encap,
2268 'type': type,
2269 'fib_table': fib_table,
2270 'n_segments': n_segments,
2271 'segments': segments
2272 }
2273 )
2274
2275 def sr_policy_del(
2276 self,
2277 bsid_addr,
2278 sr_policy_index=0):
2279 """
2280 :param bsid: bindingSID of the SR Policy
2281 :param sr_policy_index: index of the sr policy (default: 0)
2282 """
2283 return self.api(
2284 self.papi.sr_policy_del,
2285 {'bsid_addr': bsid_addr,
2286 'sr_policy_index': sr_policy_index
2287 })
2288
2289 def sr_steering_add_del(
2290 self,
2291 is_del,
2292 bsid_addr,
2293 sr_policy_index,
2294 table_id,
2295 prefix_addr,
2296 mask_width,
2297 sw_if_index,
2298 traffic_type):
2299 """
2300 Steer traffic L2 and L3 traffic through a given SR policy
2301
2302 :param is_del: delete or add
2303 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2304 :param sr_policy: is the index of the SR Policy (alt to bsid)
2305 :param table_id: is the VRF where to install the FIB entry for the BSID
2306 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2307 :param mask_width: is the mask for L3 traffic type
2308 :param sw_if_index: is the incoming interface for L2 traffic
2309 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2310 """
2311 return self.api(
2312 self.papi.sr_steering_add_del,
2313 {'is_del': is_del,
2314 'bsid_addr': bsid_addr,
2315 'sr_policy_index': sr_policy_index,
2316 'table_id': table_id,
2317 'prefix_addr': prefix_addr,
2318 'mask_width': mask_width,
2319 'sw_if_index': sw_if_index,
2320 'traffic_type': traffic_type
2321 })
Pavel Kotucek932f7412017-09-07 14:44:52 +02002322
Andrew Yourtchenko51d26512017-09-14 18:26:36 +02002323 def acl_add_replace(self, acl_index, r, tag='',
2324 expected_retval=0):
2325 """Add/replace an ACL
2326 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2327 :param acl_rule r: ACL rules array.
2328 :param str tag: symbolic tag (description) for this ACL.
2329 :param int count: number of rules.
2330 """
2331 return self.api(self.papi.acl_add_replace,
2332 {'acl_index': acl_index,
2333 'r': r,
2334 'count': len(r),
2335 'tag': tag},
2336 expected_retval=expected_retval)
2337
Andrew Yourtchenko987abe92017-09-27 13:50:31 +02002338 def acl_del(self, acl_index, expected_retval=0):
2339 """
2340
2341 :param acl_index:
2342 :return:
2343 """
2344 return self.api(self.papi.acl_del,
2345 {'acl_index': acl_index},
2346 expected_retval=expected_retval)
2347
Andrew Yourtchenko51d26512017-09-14 18:26:36 +02002348 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2349 expected_retval=0):
2350 return self.api(self.papi.acl_interface_set_acl_list,
2351 {'sw_if_index': sw_if_index,
2352 'count': len(acls),
2353 'n_input': n_input,
2354 'acls': acls},
2355 expected_retval=expected_retval)
2356
2357 def acl_dump(self, acl_index, expected_retval=0):
2358 return self.api(self.papi.acl_dump,
2359 {'acl_index': acl_index},
2360 expected_retval=expected_retval)
2361
Pavel Kotucekc29940c2017-09-07 08:17:31 +02002362 def macip_acl_add(self, rules, tag=""):
2363 """ Add MACIP acl
2364
2365 :param rules: list of rules for given acl
2366 :param tag: acl tag
2367 """
2368
2369 return self.api(self.papi.macip_acl_add,
2370 {'r': rules,
2371 'count': len(rules),
2372 'tag': tag})
2373
Pavel Kotucek932f7412017-09-07 14:44:52 +02002374 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2375 """ Add MACIP acl
2376
2377 :param rules: list of rules for given acl
2378 :param tag: acl tag
2379 """
2380
Pavel Kotucekc29940c2017-09-07 08:17:31 +02002381 return self.api(self.papi.macip_acl_add_replace,
2382 {'acl_index': acl_index,
2383 'r': rules,
Pavel Kotucek932f7412017-09-07 14:44:52 +02002384 'count': len(rules),
2385 'tag': tag})
2386
2387 def macip_acl_del(self, acl_index):
2388 """
2389
2390 :param acl_index:
2391 :return:
2392 """
2393 return self.api(self.papi.macip_acl_del,
2394 {'acl_index': acl_index})
2395
2396 def macip_acl_interface_add_del(self,
2397 sw_if_index,
2398 acl_index,
2399 is_add=1):
2400 """ Add MACIP acl to interface
2401
2402 :param sw_if_index:
2403 :param acl_index:
2404 :param is_add: (Default value = 1)
2405 """
2406
2407 return self.api(self.papi.macip_acl_interface_add_del,
2408 {'is_add': is_add,
2409 'sw_if_index': sw_if_index,
2410 'acl_index': acl_index})
2411
2412 def macip_acl_interface_get(self):
2413 """ Return interface acls dump
2414 """
2415 return self.api(
2416 self.papi.macip_acl_interface_get, {})
2417
2418 def macip_acl_dump(self, acl_index=4294967295):
2419 """ Return MACIP acl dump
2420 """
2421
2422 return self.api(
2423 self.papi.macip_acl_dump, {'acl_index': acl_index})
Neale Rannsd91c1db2017-07-31 02:30:50 -07002424
2425 def policer_add_del(self,
2426 name,
2427 cir,
2428 eir,
2429 cb,
2430 eb,
2431 is_add=1,
2432 rate_type=0,
2433 round_type=0,
2434 ptype=0,
2435 color_aware=0,
2436 conform_action_type=1,
2437 conform_dscp=0,
2438 exceed_action_type=0,
2439 exceed_dscp=0,
2440 violate_action_type=0,
2441 violate_dscp=0):
2442 return self.api(self.papi.policer_add_del,
2443 {'name': name,
2444 'cir': cir,
2445 'eir': eir,
2446 'cb': cb,
2447 'eb': eb,
2448 'is_add': is_add,
2449 'rate_type': rate_type,
2450 'round_type': round_type,
2451 'type': ptype,
2452 'color_aware': color_aware,
2453 'conform_action_type': conform_action_type,
2454 'conform_dscp': conform_dscp,
2455 'exceed_action_type': exceed_action_type,
2456 'exceed_dscp': exceed_dscp,
2457 'violate_action_type': violate_action_type,
2458 'violate_dscp': violate_dscp})
2459
2460 def ip_punt_police(self,
2461 policer_index,
2462 is_ip6=0,
2463 is_add=1):
2464 return self.api(self.papi.ip_punt_police,
2465 {'policer_index': policer_index,
2466 'is_add': is_add,
2467 'is_ip6': is_ip6})
2468
2469 def ip_punt_redirect(self,
2470 rx_sw_if_index,
2471 tx_sw_if_index,
2472 nh,
2473 is_ip6=0,
2474 is_add=1):
2475 return self.api(self.papi.ip_punt_redirect,
2476 {'rx_sw_if_index': rx_sw_if_index,
2477 'tx_sw_if_index': tx_sw_if_index,
2478 'nh': nh,
2479 'is_add': is_add,
2480 'is_ip6': is_ip6})