5 from collections import deque
7 # Sphinx creates auto-generated documentation by importing the python source
8 # 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.
13 no_vpp_papi = os.getenv("NO_VPP_PAPI")
14 if no_vpp_papi == "1":
20 from vpp_papi import VPP
22 # from vnet/vnet/mpls/mpls_types.h
23 MPLS_IETF_MAX_LABEL = 0xfffff
24 MPLS_LABEL_INVALID = MPLS_IETF_MAX_LABEL + 1
39 class UnexpectedApiReturnValueError(Exception):
40 """ exception raised when the API return value is unexpected """
44 class VppPapiProvider(object):
45 """VPP-api provider using vpp-papi
47 @property hook: hook object providing before and after api/cli hooks
50 _zero, _negative = range(2)
52 def __init__(self, name, shm_prefix, test_class):
53 self.hook = Hook("vpp-papi-provider")
55 self.shm_prefix = shm_prefix
56 self.test_class = test_class
57 self._expect_api_retval = self._zero
58 self._expect_stack = []
61 install_dir = os.getenv('VPP_TEST_INSTALL_PATH')
62 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))
66 self.vpp = VPP(jsonfiles, logger=test_class.logger)
67 self._events = deque()
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
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
84 def __exit__(self, exc_type, exc_value, traceback):
85 self._expect_api_retval = self._expect_stack.pop()
87 def register_hook(self, hook):
88 """Replace hook registration with new hook
95 def collect_events(self):
96 """ Collect all events from the internal queue and clear the queue. """
98 self._events = deque()
101 def wait_for_event(self, timeout, name=None):
102 """ Wait for and return next event. """
104 self.test_class.logger.debug("Expecting event '%s' within %ss",
107 self.test_class.logger.debug("Expecting event within %ss",
110 self.test_class.logger.debug("Not waiting, event already queued")
111 limit = time.time() + timeout
112 while time.time() < limit:
114 e = self._events.popleft()
115 if name and type(e).__name__ != name:
117 "Unexpected event received: %s, expected: %s" %
118 (type(e).__name__, name))
119 self.test_class.logger.debug("Returning event %s:%s" %
122 time.sleep(0) # yield
123 raise Exception("Event did not occur within timeout")
125 def __call__(self, name, event):
126 """ Enqueue event in the internal event queue. """
127 # FIXME use the name instead of relying on type(e).__name__ ?
128 # FIXME #2 if this throws, it is eaten silently, Ole?
129 self.test_class.logger.debug("New event: %s: %s" % (name, event))
130 self._events.append(event)
133 """Connect the API to VPP"""
134 self.vpp.connect(self.name, self.shm_prefix)
135 self.papi = self.vpp.api
136 self.vpp.register_event_callback(self)
138 def disconnect(self):
139 """Disconnect the API from VPP"""
140 self.vpp.disconnect()
142 def api(self, api_fn, api_args, expected_retval=0):
143 """ Call API function and check it's return value.
144 Call the appropriate hooks before and after the API call
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
152 self.hook.before_api(api_fn.__name__, api_args)
153 reply = api_fn(**api_args)
154 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)
160 raise UnexpectedApiReturnValueError(msg)
161 elif self._expect_api_retval == self._zero:
162 if hasattr(reply, 'retval') and reply.retval != expected_retval:
163 msg = "API call failed, expected %d return value instead "\
164 "of %d in %s" % (expected_retval, reply.retval,
166 self.test_class.logger.info(msg)
167 raise UnexpectedApiReturnValueError(msg)
169 raise Exception("Internal error, unexpected value for "
170 "self._expect_api_retval %s" %
171 self._expect_api_retval)
172 self.hook.after_api(api_fn.__name__, api_args)
176 """ Execute a CLI, calling the before/after hooks appropriately.
178 :param cli: CLI to execute
182 self.hook.before_cli(cli)
184 r = self.papi.cli_inband(length=len(cli), cmd=cli)
185 self.hook.after_cli(cli)
186 if hasattr(r, 'reply'):
187 return r.reply.decode().rstrip('\x00')
189 def ppcli(self, cli):
190 """ Helper method to print CLI command in case of info logging level.
192 :param cli: CLI to execute
195 return cli + "\n" + str(self.cli(cli))
197 def _convert_mac(self, mac):
198 return mac.replace(':', '').decode('hex')
200 def show_version(self):
202 return self.api(self.papi.show_version, {})
204 def pg_create_interface(self, pg_index):
210 return self.api(self.papi.pg_create_interface,
211 {"interface_id": pg_index})
213 def sw_interface_dump(self, filter=None):
216 :param filter: (Default value = None)
219 if filter is not None:
220 args = {"name_filter_valid": 1, "name_filter": filter}
223 return self.api(self.papi.sw_interface_dump, args)
225 def sw_interface_set_table(self, sw_if_index, is_ipv6, table_id):
226 """ Set the IPvX Table-id for the Interface
233 return self.api(self.papi.sw_interface_set_table,
234 {'sw_if_index': sw_if_index, 'is_ipv6': is_ipv6,
237 def sw_interface_add_del_address(self, sw_if_index, addr, addr_len,
238 is_ipv6=0, is_add=1, del_all=0):
241 :param addr: param is_ipv6: (Default value = 0)
244 :param is_ipv6: (Default value = 0)
245 :param is_add: (Default value = 1)
246 :param del_all: (Default value = 0)
249 return self.api(self.papi.sw_interface_add_del_address,
250 {'sw_if_index': sw_if_index,
254 'address_length': addr_len,
257 def sw_interface_set_unnumbered(self, sw_if_index, ip_sw_if_index,
259 """ Set the Interface to be unnumbered
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
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,
271 def sw_interface_enable_disable_mpls(self, sw_if_index,
274 Enable/Disable MPLS on the interface
276 :param is_enable: (Default value = 1)
279 return self.api(self.papi.sw_interface_set_mpls_enable,
280 {'sw_if_index': sw_if_index,
281 'enable': is_enable})
283 def sw_interface_ra_suppress(self, sw_if_index, suppress=1):
284 return self.api(self.papi.sw_interface_ip6nd_ra_config,
285 {'sw_if_index': sw_if_index,
286 'suppress': suppress})
288 def set_ip_flow_hash(self,
297 return self.api(self.papi.set_ip_flow_hash,
307 def ip6_nd_proxy(self, address, sw_if_index, is_del=0):
308 return self.api(self.papi.ip6nd_proxy_add_del,
310 'sw_if_index': sw_if_index,
313 def ip6_sw_interface_ra_config(self, sw_if_index,
317 return self.api(self.papi.sw_interface_ip6nd_ra_config,
318 {'sw_if_index': sw_if_index,
320 'suppress': suppress,
321 'send_unicast': send_unicast})
323 def ip6_sw_interface_ra_prefix(self,
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,
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,
345 'val_lifetime': val_lifetime,
346 'pref_lifetime': pref_lifetime})
348 def ip6_sw_interface_enable_disable(self, sw_if_index, enable):
350 Enable/Disable An interface for IPv6
352 return self.api(self.papi.sw_interface_ip6_enable_disable,
353 {'sw_if_index': sw_if_index,
356 def vxlan_add_del_tunnel(
360 mcast_sw_if_index=0xFFFFFFFF,
364 decap_next_index=0xFFFFFFFF,
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)
374 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
375 :param vni: (Default value = 0)
378 return self.api(self.papi.vxlan_add_del_tunnel,
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,
388 def geneve_add_del_tunnel(
392 mcast_sw_if_index=0xFFFFFFFF,
396 decap_next_index=0xFFFFFFFF,
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)
410 return self.api(self.papi.geneve_add_del_tunnel,
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,
420 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.
424 :param int bd_id: Bridge domain index.
425 :param int flood: Enable/disable bcast/mcast flooding in the BD.
427 :param int uu_flood: Enable/disable unknown unicast flood in the BD.
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.
433 :param int arp_term: Enable/disable arp termination in the BD.
435 :param int is_add: Add or delete flag. (Default value = 1)
437 return self.api(self.papi.bridge_domain_add_del,
440 'uu_flood': uu_flood,
443 'arp_term': arp_term,
446 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,
454 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,
458 'pid': os.getpid(), })
460 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,
464 'pid': os.getpid(), })
466 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(), })
475 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.
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.
485 :param int filter_mac: Set to 1 to drop packet that's source or
486 destination MAC address contains defined MAC address.
488 :param int bvi_mac: Set to 1 to create entry that points to BVI
489 interface. (Default value = 0)
491 return self.api(self.papi.l2fib_add_del,
492 {'mac': self._convert_mac(mac),
494 'sw_if_index': sw_if_index,
496 'static_mac': static_mac,
497 'filter_mac': filter_mac,
500 def l2fib_flush_int(self, sw_if_index):
501 """Flush L2 FIB entries for sw_if_index.
503 :param int sw_if_index: Software interface index of the interface.
505 return self.api(self.papi.l2fib_flush_int,
506 {'sw_if_index': sw_if_index})
508 def l2fib_flush_bd(self, bd_id):
509 """Flush L2 FIB entries for bd_id.
511 :param int sw_if_index: Bridge Domain id.
513 return self.api(self.papi.l2fib_flush_bd,
516 def l2fib_flush_all(self):
519 return self.api(self.papi.l2fib_flush_all, {})
521 def sw_interface_set_l2_bridge(self, sw_if_index, bd_id,
522 shg=0, bvi=0, enable=1):
523 """Add/remove interface to/from bridge domain.
525 :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.
530 :param int enable: Add or remove interface. (Default value = 1)
532 return self.api(self.papi.sw_interface_set_l2_bridge,
533 {'rx_sw_if_index': sw_if_index,
539 def bridge_flags(self, bd_id, is_set, feature_bitmap):
540 """Enable/disable required feature of the bridge domain with defined ID.
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:
548 - uu-flood (1 << 3) or
551 return self.api(self.papi.bridge_flags,
554 'feature_bitmap': feature_bitmap})
556 def bridge_domain_dump(self, bd_id=0):
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.
563 return self.api(self.papi.bridge_domain_dump,
566 def sw_interface_set_l2_xconnect(self, rx_sw_if_index, tx_sw_if_index,
568 """Create or delete unidirectional cross-connect from Tx interface to
571 :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.
577 return self.api(self.papi.sw_interface_set_l2_xconnect,
578 {'rx_sw_if_index': rx_sw_if_index,
579 'tx_sw_if_index': tx_sw_if_index,
582 def sw_interface_set_l2_tag_rewrite(
589 """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
599 return self.api(self.papi.l2_interface_vlan_tag_rewrite,
600 {'sw_if_index': sw_if_index,
606 def sw_interface_set_flags(self, sw_if_index, admin_up_down):
609 :param admin_up_down:
613 return self.api(self.papi.sw_interface_set_flags,
614 {'sw_if_index': sw_if_index,
615 'admin_up_down': admin_up_down})
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
623 :param sub_id: 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)
638 self.papi.create_subif,
639 {'sw_if_index': sw_if_index,
643 'two_tags': two_tags,
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})
652 def create_p2pethernet_subif(self, sw_if_index, remote_mac, subif_id):
653 """Create p2p ethernet subinterface
655 :param sw_if_index: main (parent) interface
656 :param remote_mac: client (remote) mac address
660 self.papi.p2p_ethernet_add,
661 {'parent_if_index': sw_if_index,
662 'remote_mac': remote_mac,
663 'subif_id': subif_id})
665 def delete_subif(self, sw_if_index):
666 """Delete subinterface
670 return self.api(self.papi.delete_subif,
671 {'sw_if_index': sw_if_index})
673 def delete_p2pethernet_subif(self, sw_if_index, remote_mac):
674 """Delete p2p ethernet subinterface
676 :param sw_if_index: main (parent) interface
677 :param remote_mac: client (remote) mac address
681 self.papi.p2p_ethernet_del,
682 {'parent_if_index': sw_if_index,
683 'remote_mac': remote_mac})
685 def create_vlan_subif(self, sw_if_index, vlan):
692 return self.api(self.papi.create_vlan_subif,
693 {'sw_if_index': sw_if_index,
696 def create_loopback(self, mac=''):
699 :param mac: (Optional)
701 return self.api(self.papi.create_loopback,
702 {'mac_address': mac})
704 def delete_loopback(self, sw_if_index):
705 return self.api(self.papi.delete_loopback,
706 {'sw_if_index': sw_if_index, })
708 def ip_table_add_del(self,
715 :param is_add: (Default value = 1)
716 :param is_ipv6: (Default value = 0)
721 self.papi.ip_table_add_del,
722 {'table_id': table_id,
726 def ip_add_del_route(
731 next_hop_sw_if_index=0xFFFFFFFF,
735 next_hop_n_out_labels=0,
736 next_hop_out_label_stack=[],
737 next_hop_via_label=MPLS_LABEL_INVALID,
738 next_hop_id=0xFFFFFFFF,
740 is_resolve_attached=0,
741 classify_table_index=0xFFFFFFFF,
755 :param dst_address_length:
756 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
758 :param next_hop_address:
759 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
760 :param vrf_id: (Default value = 0)
761 :param lookup_in_vrf: (Default value = 0)
762 :param classify_table_index: (Default value = 0xFFFFFFFF)
763 :param is_add: (Default value = 1)
764 :param is_drop: (Default value = 0)
765 :param is_ipv6: (Default value = 0)
766 :param is_local: (Default value = 0)
767 :param is_classify: (Default value = 0)
768 :param is_multipath: (Default value = 0)
769 :param is_resolve_host: (Default value = 0)
770 :param is_resolve_attached: (Default value = 0)
771 :param is_l2_bridged: (Default value = 0)
772 :param is_source_lookup: (Default value = 0)
773 :param next_hop_weight: (Default value = 1)
778 self.papi.ip_add_del_route,
779 {'next_hop_sw_if_index': next_hop_sw_if_index,
780 'table_id': table_id,
781 'classify_table_index': classify_table_index,
782 'next_hop_table_id': next_hop_table_id,
785 'is_unreach': is_unreach,
786 'is_prohibit': is_prohibit,
788 'is_local': is_local,
789 'is_classify': is_classify,
790 'is_multipath': is_multipath,
791 'is_resolve_host': is_resolve_host,
792 'is_resolve_attached': is_resolve_attached,
793 'is_l2_bridged': is_l2_bridged,
794 'is_source_lookup': is_source_lookup,
795 'is_udp_encap': is_udp_encap,
796 'next_hop_weight': next_hop_weight,
797 'dst_address_length': dst_address_length,
798 'dst_address': dst_address,
799 'next_hop_id': next_hop_id,
800 'next_hop_address': next_hop_address,
801 'next_hop_n_out_labels': next_hop_n_out_labels,
802 'next_hop_via_label': next_hop_via_label,
803 'next_hop_out_label_stack': next_hop_out_label_stack})
805 def ip_fib_dump(self):
806 return self.api(self.papi.ip_fib_dump, {})
808 def ip6_fib_dump(self):
809 return self.api(self.papi.ip6_fib_dump, {})
811 def ip_neighbor_add_del(self,
820 """ Add neighbor MAC to IPv4 or IPv6 address.
825 :param is_add: (Default value = 1)
826 :param is_ipv6: (Default value = 0)
827 :param is_static: (Default value = 0)
828 :param is_no_adj_fib: (Default value = 0)
832 self.papi.ip_neighbor_add_del,
833 {'sw_if_index': sw_if_index,
836 'is_static': is_static,
837 'is_no_adj_fib': is_no_adj_fib,
838 'mac_address': mac_address,
839 'dst_address': dst_address
843 def ip_neighbor_dump(self,
846 """ Return IP neighbor dump.
849 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
853 self.papi.ip_neighbor_dump,
855 'sw_if_index': sw_if_index
859 def proxy_arp_add_del(self,
864 """ Config Proxy Arp Range.
866 :param low_address: Start address in the rnage to Proxy for
867 :param hi_address: End address in the rnage to Proxy for
868 :param vrf_id: The VRF/table in which to proxy
872 self.papi.proxy_arp_add_del,
875 'low_address': low_address,
876 'hi_address': hi_address,
880 def proxy_arp_intfc_enable_disable(self,
883 """ Enable/Disable an interface for proxy ARP requests
885 :param sw_if_index: Interface
886 :param enable_disable: Enable/Disable
890 self.papi.proxy_arp_intfc_enable_disable,
891 {'sw_if_index': sw_if_index,
892 'enable_disable': is_enable
900 """ Reset VRF (remove all routes etc.) request.
902 :param int vrf_id: ID of the FIB table / VRF to reset.
903 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
917 """ Reset VRF (remove all routes etc.) request.
919 :param int vrf_id: ID of the FIB table / VRF to reset.
920 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
935 :param int is_ipv6: 1 for IPv6 neighbor, 0 for IPv4. (Default = 0)
944 def sw_interface_span_enable_disable(
945 self, sw_if_index_from, sw_if_index_to, state=1, is_l2=0):
948 :param sw_if_index_from:
949 :param sw_if_index_to:
953 return self.api(self.papi.sw_interface_span_enable_disable,
954 {'sw_if_index_from': sw_if_index_from,
955 'sw_if_index_to': sw_if_index_to,
960 def gre_tunnel_add_del(self,
971 :param outer_fib_id: (Default value = 0)
972 :param is_add: (Default value = 1)
973 :param is_ipv6: (Default value = 0)
974 :param is_teb: (Default value = 0)
978 self.papi.gre_add_del_tunnel,
982 'src_address': src_address,
983 'dst_address': dst_address,
984 'outer_fib_id': outer_fib_id}
987 def udp_encap_add_del(self,
997 :param id: user provided ID
1002 :param outer_fib_id: (Default value = 0)
1003 :param is_add: (Default value = 1)
1004 :param is_ipv6: (Default value = 0)
1008 self.papi.udp_encap_add_del,
1014 'src_port': src_port,
1015 'dst_port': dst_port,
1016 'table_id': table_id}
1019 def udp_encap_dump(self):
1020 return self.api(self.papi.udp_encap_dump, {})
1022 def mpls_fib_dump(self):
1023 return self.api(self.papi.mpls_fib_dump, {})
1025 def mpls_table_add_del(
1032 :param is_add: (Default value = 1)
1037 self.papi.mpls_table_add_del,
1038 {'mt_table_id': table_id,
1039 'mt_is_add': is_add})
1041 def mpls_route_add_del(
1047 next_hop_sw_if_index=0xFFFFFFFF,
1049 next_hop_table_id=0,
1051 next_hop_n_out_labels=0,
1052 next_hop_out_label_stack=[],
1053 next_hop_via_label=MPLS_LABEL_INVALID,
1055 is_resolve_attached=0,
1062 classify_table_index=0xFFFFFFFF,
1066 :param dst_address_length:
1067 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1069 :param next_hop_address:
1070 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1071 :param vrf_id: (Default value = 0)
1072 :param lookup_in_vrf: (Default value = 0)
1073 :param classify_table_index: (Default value = 0xFFFFFFFF)
1074 :param is_add: (Default value = 1)
1075 :param is_drop: (Default value = 0)
1076 :param is_ipv6: (Default value = 0)
1077 :param is_local: (Default value = 0)
1078 :param is_classify: (Default value = 0)
1079 :param is_multipath: (Default value = 0)
1080 :param is_multicast: (Default value = 0)
1081 :param is_resolve_host: (Default value = 0)
1082 :param is_resolve_attached: (Default value = 0)
1083 :param next_hop_weight: (Default value = 1)
1088 self.papi.mpls_route_add_del,
1091 'mr_table_id': table_id,
1092 'mr_classify_table_index': classify_table_index,
1093 'mr_is_add': is_add,
1094 'mr_is_classify': is_classify,
1095 'mr_is_multipath': is_multipath,
1096 'mr_is_multicast': is_multicast,
1097 'mr_is_resolve_host': is_resolve_host,
1098 'mr_is_resolve_attached': is_resolve_attached,
1099 'mr_is_interface_rx': is_interface_rx,
1100 'mr_is_rpf_id': is_rpf_id,
1101 'mr_next_hop_proto': next_hop_proto,
1102 'mr_next_hop_weight': next_hop_weight,
1103 'mr_next_hop': next_hop_address,
1104 'mr_next_hop_n_out_labels': next_hop_n_out_labels,
1105 'mr_next_hop_sw_if_index': next_hop_sw_if_index,
1106 'mr_next_hop_table_id': next_hop_table_id,
1107 'mr_next_hop_via_label': next_hop_via_label,
1108 'mr_next_hop_out_label_stack': next_hop_out_label_stack})
1110 def mpls_ip_bind_unbind(
1122 self.papi.mpls_ip_bind_unbind,
1123 {'mb_mpls_table_id': table_id,
1125 'mb_ip_table_id': ip_table_id,
1126 'mb_is_bind': is_bind,
1127 'mb_is_ip4': is_ip4,
1128 'mb_address_length': dst_address_length,
1129 'mb_address': dst_address})
1131 def mpls_tunnel_add_del(
1134 next_hop_proto_is_ip4,
1136 next_hop_sw_if_index=0xFFFFFFFF,
1137 next_hop_table_id=0,
1139 next_hop_n_out_labels=0,
1140 next_hop_out_label_stack=[],
1141 next_hop_via_label=MPLS_LABEL_INVALID,
1147 :param dst_address_length:
1148 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1150 :param next_hop_address:
1151 :param next_hop_sw_if_index: (Default value = 0xFFFFFFFF)
1152 :param vrf_id: (Default value = 0)
1153 :param lookup_in_vrf: (Default value = 0)
1154 :param classify_table_index: (Default value = 0xFFFFFFFF)
1155 :param is_add: (Default value = 1)
1156 :param is_drop: (Default value = 0)
1157 :param is_ipv6: (Default value = 0)
1158 :param is_local: (Default value = 0)
1159 :param is_classify: (Default value = 0)
1160 :param is_multipath: (Default value = 0)
1161 :param is_resolve_host: (Default value = 0)
1162 :param is_resolve_attached: (Default value = 0)
1163 :param next_hop_weight: (Default value = 1)
1164 :param is_multicast: (Default value = 0)
1168 self.papi.mpls_tunnel_add_del,
1169 {'mt_sw_if_index': tun_sw_if_index,
1170 'mt_is_add': is_add,
1171 'mt_l2_only': l2_only,
1172 'mt_is_multicast': is_multicast,
1173 'mt_next_hop_proto_is_ip4': next_hop_proto_is_ip4,
1174 'mt_next_hop_weight': next_hop_weight,
1175 'mt_next_hop': next_hop_address,
1176 'mt_next_hop_n_out_labels': next_hop_n_out_labels,
1177 'mt_next_hop_sw_if_index': next_hop_sw_if_index,
1178 'mt_next_hop_table_id': next_hop_table_id,
1179 'mt_next_hop_out_label_stack': next_hop_out_label_stack})
1181 def nat44_interface_add_del_feature(
1186 """Enable/disable NAT44 feature on the interface
1188 :param sw_if_index: Software index of the interface
1189 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1190 :param is_add: 1 if add, 0 if delete (Default value = 1)
1193 self.papi.nat44_interface_add_del_feature,
1195 'is_inside': is_inside,
1196 'sw_if_index': sw_if_index})
1198 def nat44_interface_add_del_output_feature(
1203 """Enable/disable NAT44 output feature on the interface
1205 :param sw_if_index: Software index of the interface
1206 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1207 :param is_add: 1 if add, 0 if delete (Default value = 1)
1210 self.papi.nat44_interface_add_del_output_feature,
1212 'is_inside': is_inside,
1213 'sw_if_index': sw_if_index})
1215 def nat44_add_del_static_mapping(
1219 external_sw_if_index=0xFFFFFFFF,
1226 """Add/delete NAT44 static mapping
1228 :param local_ip: Local IP address
1229 :param external_ip: External IP address
1230 :param external_sw_if_index: External interface instead of IP address
1231 :param local_port: Local port number (Default value = 0)
1232 :param external_port: External port number (Default value = 0)
1233 :param addr_only: 1 if address only mapping, 0 if address and port
1234 :param vrf_id: VRF ID
1235 :param protocol: IP protocol (Default value = 0)
1236 :param is_add: 1 if add, 0 if delete (Default value = 1)
1239 self.papi.nat44_add_del_static_mapping,
1241 'addr_only': addr_only,
1242 'local_ip_address': local_ip,
1243 'external_ip_address': external_ip,
1244 'local_port': local_port,
1245 'external_port': external_port,
1246 'external_sw_if_index': external_sw_if_index,
1248 'protocol': protocol})
1250 def nat44_add_del_identity_mapping(
1253 sw_if_index=0xFFFFFFFF,
1259 """Add/delete NAT44 identity mapping
1261 :param ip: IP address (Default value = 0)
1262 :param sw_if_index: Interface instead of IP address
1263 :param port: Port number (Default value = 0)
1264 :param addr_only: 1 if address only mapping, 0 if address and port
1265 :param vrf_id: VRF ID
1266 :param protocol: IP protocol (Default value = 0)
1267 :param is_add: 1 if add, 0 if delete (Default value = 1)
1270 self.papi.nat44_add_del_identity_mapping,
1272 'addr_only': addr_only,
1275 'sw_if_index': sw_if_index,
1277 'protocol': protocol})
1279 def nat44_add_del_address_range(
1285 """Add/del NAT44 address range
1287 :param first_ip_address: First IP address
1288 :param last_ip_address: Last IP address
1289 :param vrf_id: VRF id for the address range
1290 :param is_add: 1 if add, 0 if delete (Default value = 1)
1293 self.papi.nat44_add_del_address_range,
1294 {'first_ip_address': first_ip_address,
1295 'last_ip_address': last_ip_address,
1299 def nat44_address_dump(self):
1300 """Dump NAT44 addresses
1301 :return: Dictionary of NAT44 addresses
1303 return self.api(self.papi.nat44_address_dump, {})
1305 def nat44_interface_dump(self):
1306 """Dump interfaces with NAT44 feature
1307 :return: Dictionary of interfaces with NAT44 feature
1309 return self.api(self.papi.nat44_interface_dump, {})
1311 def nat44_interface_output_feature_dump(self):
1312 """Dump interfaces with NAT44 output feature
1313 :return: Dictionary of interfaces with NAT44 output feature
1315 return self.api(self.papi.nat44_interface_output_feature_dump, {})
1317 def nat44_static_mapping_dump(self):
1318 """Dump NAT44 static mappings
1319 :return: Dictionary of NAT44 static mappings
1321 return self.api(self.papi.nat44_static_mapping_dump, {})
1323 def nat44_identity_mapping_dump(self):
1324 """Dump NAT44 identity mappings
1325 :return: Dictionary of NAT44 identity mappings
1327 return self.api(self.papi.nat44_identity_mapping_dump, {})
1329 def nat_show_config(self):
1330 """Show NAT plugin config
1331 :return: NAT plugin config parameters
1333 return self.api(self.papi.nat_show_config, {})
1335 def nat44_add_interface_addr(
1339 """Add/del NAT44 address from interface
1341 :param sw_if_index: Software index of the interface
1342 :param is_add: 1 if add, 0 if delete (Default value = 1)
1344 return self.api(self.papi.nat44_add_del_interface_addr,
1345 {'is_add': is_add, 'sw_if_index': sw_if_index})
1347 def nat44_interface_addr_dump(self):
1348 """Dump NAT44 addresses interfaces
1349 :return: Dictionary of NAT44 addresses interfaces
1351 return self.api(self.papi.nat44_interface_addr_dump, {})
1358 """Enable/disable NAT IPFIX logging
1360 :param domain_id: Observation domain ID (Default value = 1)
1361 :param src_port: Source port number (Default value = 4739)
1362 :param enable: 1 if enable, 0 if disable (Default value = 1)
1365 self.papi.nat_ipfix_enable_disable,
1366 {'domain_id': domain_id,
1367 'src_port': src_port,
1370 def nat44_user_session_dump(
1374 """Dump NAT44 user's sessions
1376 :param ip_address: ip adress of the user to be dumped
1377 :param cpu_index: cpu_index on which the user is
1378 :param vrf_id: VRF ID
1379 :return: Dictionary of S-NAT sessions
1382 self.papi.nat44_user_session_dump,
1383 {'ip_address': ip_address,
1386 def nat44_user_dump(self):
1389 :return: Dictionary of NAT44 users
1391 return self.api(self.papi.nat44_user_dump, {})
1393 def nat44_add_del_lb_static_mapping(
1402 """Add/delete NAT44 load balancing static mapping
1404 :param is_add - 1 if add, 0 if delete
1407 self.papi.nat44_add_del_lb_static_mapping,
1409 'external_addr': external_addr,
1410 'external_port': external_port,
1411 'protocol': protocol,
1413 'local_num': local_num,
1416 def nat44_lb_static_mapping_dump(self):
1417 """Dump NAT44 load balancing static mappings
1419 :return: Dictionary of NAT44 load balancing static mapping
1421 return self.api(self.papi.nat44_lb_static_mapping_dump, {})
1423 def nat44_del_session(
1430 """Delete NAT44 session
1432 :param addr: IPv4 address
1433 :param por: port number
1434 :param protocol: IP protocol number
1435 :param vrf_id: VRF ID
1436 :param is_in: 1 if inside network addres and port pari, 0 if outside
1439 self.papi.nat44_del_session,
1442 'protocol': protocol,
1453 """Set NAT virtual fragmentation reassembly
1455 :param timeout: reassembly timeout (Default 2sec)
1456 :param max_reass: maximum concurrent reassemblies (Default 1024)
1457 :param max_frag: maximum fragmets per reassembly (Default 5)
1458 :param drop_frag: if 0 translate fragments, otherwise drop fragments
1459 :param is_ip6: 1 if IPv6, 0 if IPv4
1462 self.papi.nat_set_reass,
1463 {'timeout': timeout,
1464 'max_reass': max_reass,
1465 'max_frag': max_frag,
1466 'drop_frag': drop_frag,
1469 def nat_get_reass(self):
1470 """Get NAT virtual fragmentation reassembly configuration
1472 :return: NAT virtual fragmentation reassembly configuration
1474 return self.api(self.papi.nat_get_reass, {})
1476 def nat_reass_dump(self):
1477 """Dump NAT virtual fragmentation reassemblies
1479 :return: Dictionary of NAT virtual fragmentation reassemblies
1481 return self.api(self.papi.nat_reass_dump, {})
1483 def nat_det_add_del_map(
1490 """Add/delete deterministic NAT mapping
1492 :param is_add - 1 if add, 0 if delete
1493 :param in_addr - inside IP address
1494 :param in_plen - inside IP address prefix length
1495 :param out_addr - outside IP address
1496 :param out_plen - outside IP address prefix length
1499 self.papi.nat_det_add_del_map,
1504 'out_addr': out_addr,
1505 'out_plen': out_plen})
1507 def nat_det_forward(
1510 """Get outside address and port range from inside address
1512 :param in_addr - inside IP address
1515 self.papi.nat_det_forward,
1516 {'in_addr': in_addr,
1519 def nat_det_reverse(
1523 """Get inside address from outside address and port
1525 :param out_addr - outside IP address
1526 :param out_port - outside port
1529 self.papi.nat_det_reverse,
1530 {'out_addr': out_addr,
1531 'out_port': out_port})
1533 def nat_det_map_dump(self):
1534 """Dump deterministic NAT mappings
1536 :return: Dictionary of deterministic NAT mappings
1538 return self.api(self.papi.nat_det_map_dump, {})
1540 def nat_det_set_timeouts(
1543 tcp_established=7440,
1546 """Set values of timeouts for deterministic NAT (in seconds)
1548 :param udp - UDP timeout (Default value = 300)
1549 :param tcp_established - TCP established timeout (Default value = 7440)
1550 :param tcp_transitory - TCP transitory timeout (Default value = 240)
1551 :param icmp - ICMP timeout (Default value = 60)
1554 self.papi.nat_det_set_timeouts,
1556 'tcp_established': tcp_established,
1557 'tcp_transitory': tcp_transitory,
1560 def nat_det_get_timeouts(self):
1561 """Get values of timeouts for deterministic NAT
1563 :return: Timeouts for deterministic NAT (in seconds)
1565 return self.api(self.papi.nat_det_get_timeouts, {})
1567 def nat_det_close_session_out(
1573 """Close deterministic NAT session using outside address and port
1575 :param out_addr - outside IP address
1576 :param out_port - outside port
1577 :param ext_addr - external host IP address
1578 :param ext_port - external host port
1581 self.papi.nat_det_close_session_out,
1582 {'out_addr': out_addr,
1583 'out_port': out_port,
1584 'ext_addr': ext_addr,
1585 'ext_port': ext_port})
1587 def nat_det_close_session_in(
1593 """Close deterministic NAT session using inside address and port
1595 :param in_addr - inside IP address
1596 :param in_port - inside port
1597 :param ext_addr - external host IP address
1598 :param ext_port - external host port
1601 self.papi.nat_det_close_session_in,
1602 {'in_addr': in_addr,
1604 'ext_addr': ext_addr,
1605 'ext_port': ext_port,
1608 def nat_det_session_dump(
1611 """Dump deterministic NAT sessions belonging to a user
1613 :param user_addr - inside IP address of the user
1614 :return: Dictionary of deterministic NAT sessions
1617 self.papi.nat_det_session_dump,
1619 'user_addr': user_addr})
1621 def nat64_add_del_pool_addr_range(
1627 """Add/del address range to NAT64 pool
1629 :param start_addr: First IP address
1630 :param end_addr: Last IP address
1631 :param vrf_id: VRF id for the address range
1632 :param is_add: 1 if add, 0 if delete (Default value = 1)
1635 self.papi.nat64_add_del_pool_addr_range,
1636 {'start_addr': start_addr,
1637 'end_addr': end_addr,
1641 def nat64_pool_addr_dump(self):
1642 """Dump NAT64 pool addresses
1643 :return: Dictionary of NAT64 pool addresses
1645 return self.api(self.papi.nat64_pool_addr_dump, {})
1647 def nat64_add_del_interface(
1652 """Enable/disable NAT64 feature on the interface
1653 :param sw_if_index: Index of the interface
1654 :param is_inside: 1 if inside, 0 if outside (Default value = 1)
1655 :param is_add: 1 if add, 0 if delete (Default value = 1)
1658 self.papi.nat64_add_del_interface,
1659 {'sw_if_index': sw_if_index,
1660 'is_inside': is_inside,
1663 def nat64_interface_dump(self):
1664 """Dump interfaces with NAT64 feature
1665 :return: Dictionary of interfaces with NAT64 feature
1667 return self.api(self.papi.nat64_interface_dump, {})
1669 def nat64_add_del_static_bib(
1678 """Add/delete S-NAT static BIB entry
1680 :param in_ip: Inside IPv6 address
1681 :param out_ip: Outside IPv4 address
1682 :param in_port: Inside port number
1683 :param out_port: Outside port number
1684 :param protocol: IP protocol
1685 :param vrf_id: VRF ID (Default value = 0)
1686 :param is_add: 1 if add, 0 if delete (Default value = 1)
1689 self.papi.nat64_add_del_static_bib,
1698 def nat64_bib_dump(self, protocol=255):
1701 :param protocol: IP protocol (Default value = 255, all BIBs)
1702 :returns: Dictionary of NAT64 BIB entries
1704 return self.api(self.papi.nat64_bib_dump, {'proto': protocol})
1706 def nat64_set_timeouts(self, udp=300, icmp=60, tcp_trans=240, tcp_est=7440,
1707 tcp_incoming_syn=6):
1708 """Set values of timeouts for NAT64 (in seconds)
1710 :param udpi: UDP timeout (Default value = 300)
1711 :param icmp: ICMP timeout (Default value = 60)
1712 :param tcp_trans: TCP transitory timeout (Default value = 240)
1713 :param tcp_est: TCP established timeout (Default value = 7440)
1714 :param tcp_incoming_syn: TCP incoming SYN timeout (Default value = 6)
1717 self.papi.nat64_set_timeouts,
1720 'tcp_trans': tcp_trans,
1722 'tcp_incoming_syn': tcp_incoming_syn})
1724 def nat64_get_timeouts(self):
1725 """Get values of timeouts for NAT64
1727 :return: Timeouts for NAT64 (in seconds)
1729 return self.api(self.papi.nat64_get_timeouts, {})
1731 def nat64_st_dump(self, protocol=255):
1732 """Dump NAT64 session table
1734 :param protocol: IP protocol (Default value = 255, all STs)
1735 :returns: Dictionary of NAT64 sesstion table entries
1737 return self.api(self.papi.nat64_st_dump, {'proto': protocol})
1739 def nat64_add_del_prefix(self, prefix, plen, vrf_id=0, is_add=1):
1740 """Add/del NAT64 prefix
1742 :param prefix: NAT64 prefix
1743 :param plen: NAT64 prefix length
1744 :param vrf_id: VRF id of tenant (Default 0)
1745 :param is_add: 1 if add, 0 if delete (Default value = 1)
1748 self.papi.nat64_add_del_prefix,
1754 def nat64_prefix_dump(self):
1755 """Dump NAT64 prefix
1757 :returns: Dictionary of NAT64 prefixes
1759 return self.api(self.papi.nat64_prefix_dump, {})
1761 def nat64_add_interface_addr(
1765 """Add/del NAT64 address from interface
1767 :param sw_if_index: Software index of the interface
1768 :param is_add: 1 if add, 0 if delete (Default value = 1)
1770 return self.api(self.papi.nat64_add_del_interface_addr,
1771 {'is_add': is_add, 'sw_if_index': sw_if_index})
1773 def dslite_set_aftr_addr(self, ip6, ip4):
1774 """Set DS-Lite AFTR addresses
1776 :param ip4: IPv4 address
1777 :param ip6: IPv6 address
1780 self.papi.dslite_set_aftr_addr,
1784 def dslite_add_del_pool_addr_range(
1789 """Add/del address range to DS-Lite pool
1791 :param start_addr: First IP address
1792 :param end_addr: Last IP address
1793 :param is_add: 1 if add, 0 if delete (Default value = 1)
1796 self.papi.dslite_add_del_pool_addr_range,
1797 {'start_addr': start_addr,
1798 'end_addr': end_addr,
1801 def control_ping(self):
1802 self.api(self.papi.control_ping)
1804 def bfd_udp_add(self, sw_if_index, desired_min_tx, required_min_rx,
1805 detect_mult, local_addr, peer_addr, is_ipv6=0,
1806 bfd_key_id=None, conf_key_id=None):
1807 if bfd_key_id is None:
1808 return self.api(self.papi.bfd_udp_add,
1810 'sw_if_index': sw_if_index,
1811 'desired_min_tx': desired_min_tx,
1812 'required_min_rx': required_min_rx,
1813 'local_addr': local_addr,
1814 'peer_addr': peer_addr,
1816 'detect_mult': detect_mult,
1819 return self.api(self.papi.bfd_udp_add,
1821 'sw_if_index': sw_if_index,
1822 'desired_min_tx': desired_min_tx,
1823 'required_min_rx': required_min_rx,
1824 'local_addr': local_addr,
1825 'peer_addr': peer_addr,
1827 'detect_mult': detect_mult,
1828 'is_authenticated': 1,
1829 'bfd_key_id': bfd_key_id,
1830 'conf_key_id': conf_key_id,
1833 def bfd_udp_mod(self, sw_if_index, desired_min_tx, required_min_rx,
1834 detect_mult, local_addr, peer_addr, is_ipv6=0):
1835 return self.api(self.papi.bfd_udp_mod,
1837 'sw_if_index': sw_if_index,
1838 'desired_min_tx': desired_min_tx,
1839 'required_min_rx': required_min_rx,
1840 'local_addr': local_addr,
1841 'peer_addr': peer_addr,
1843 'detect_mult': detect_mult,
1846 def bfd_udp_auth_activate(self, sw_if_index, local_addr, peer_addr,
1847 is_ipv6=0, bfd_key_id=None, conf_key_id=None,
1849 return self.api(self.papi.bfd_udp_auth_activate,
1851 'sw_if_index': sw_if_index,
1852 'local_addr': local_addr,
1853 'peer_addr': peer_addr,
1855 'is_delayed': 1 if is_delayed else 0,
1856 'bfd_key_id': bfd_key_id,
1857 'conf_key_id': conf_key_id,
1860 def bfd_udp_auth_deactivate(self, sw_if_index, local_addr, peer_addr,
1861 is_ipv6=0, is_delayed=False):
1862 return self.api(self.papi.bfd_udp_auth_deactivate,
1864 'sw_if_index': sw_if_index,
1865 'local_addr': local_addr,
1866 'peer_addr': peer_addr,
1868 'is_delayed': 1 if is_delayed else 0,
1871 def bfd_udp_del(self, sw_if_index, local_addr, peer_addr, is_ipv6=0):
1872 return self.api(self.papi.bfd_udp_del,
1874 'sw_if_index': sw_if_index,
1875 'local_addr': local_addr,
1876 'peer_addr': peer_addr,
1880 def bfd_udp_session_dump(self):
1881 return self.api(self.papi.bfd_udp_session_dump, {})
1883 def bfd_udp_session_set_flags(self, admin_up_down, sw_if_index, local_addr,
1884 peer_addr, is_ipv6=0):
1885 return self.api(self.papi.bfd_udp_session_set_flags, {
1886 'admin_up_down': admin_up_down,
1887 'sw_if_index': sw_if_index,
1888 'local_addr': local_addr,
1889 'peer_addr': peer_addr,
1893 def want_bfd_events(self, enable_disable=1):
1894 return self.api(self.papi.want_bfd_events, {
1895 'enable_disable': enable_disable,
1899 def bfd_auth_set_key(self, conf_key_id, auth_type, key):
1900 return self.api(self.papi.bfd_auth_set_key, {
1901 'conf_key_id': conf_key_id,
1902 'auth_type': auth_type,
1904 'key_len': len(key),
1907 def bfd_auth_del_key(self, conf_key_id):
1908 return self.api(self.papi.bfd_auth_del_key, {
1909 'conf_key_id': conf_key_id,
1912 def bfd_auth_keys_dump(self):
1913 return self.api(self.papi.bfd_auth_keys_dump, {})
1915 def bfd_udp_set_echo_source(self, sw_if_index):
1916 return self.api(self.papi.bfd_udp_set_echo_source,
1917 {'sw_if_index': sw_if_index})
1919 def bfd_udp_del_echo_source(self):
1920 return self.api(self.papi.bfd_udp_del_echo_source, {})
1922 def classify_add_del_table(
1927 table_index=0xFFFFFFFF,
1929 memory_size=2097152,
1931 next_table_index=0xFFFFFFFF,
1932 miss_next_index=0xFFFFFFFF,
1933 current_data_flag=0,
1934 current_data_offset=0):
1938 :param match_n_vectors: (Default value = 1)
1939 :param table_index: (Default value = 0xFFFFFFFF)
1940 :param nbuckets: (Default value = 2)
1941 :param memory_size: (Default value = 2097152)
1942 :param skip_n_vectors: (Default value = 0)
1943 :param next_table_index: (Default value = 0xFFFFFFFF)
1944 :param miss_next_index: (Default value = 0xFFFFFFFF)
1945 :param current_data_flag: (Default value = 0)
1946 :param current_data_offset: (Default value = 0)
1950 self.papi.classify_add_del_table,
1952 'table_index': table_index,
1953 'nbuckets': nbuckets,
1954 'memory_size': memory_size,
1955 'skip_n_vectors': skip_n_vectors,
1956 'match_n_vectors': match_n_vectors,
1957 'next_table_index': next_table_index,
1958 'miss_next_index': miss_next_index,
1959 'current_data_flag': current_data_flag,
1960 'current_data_offset': current_data_offset,
1963 def classify_add_del_session(
1968 opaque_index=0xFFFFFFFF,
1969 hit_next_index=0xFFFFFFFF,
1977 :param opaque_index: (Default value = 0xFFFFFFFF)
1978 :param hit_next_index: (Default value = 0xFFFFFFFF)
1979 :param advance: (Default value = 0)
1980 :param action: (Default value = 0)
1981 :param metadata: (Default value = 0)
1985 self.papi.classify_add_del_session,
1987 'table_index': table_index,
1988 'hit_next_index': hit_next_index,
1989 'opaque_index': opaque_index,
1992 'metadata': metadata,
1995 def input_acl_set_interface(
1999 ip4_table_index=0xFFFFFFFF,
2000 ip6_table_index=0xFFFFFFFF,
2001 l2_table_index=0xFFFFFFFF):
2005 :param ip4_table_index: (Default value = 0xFFFFFFFF)
2006 :param ip6_table_index: (Default value = 0xFFFFFFFF)
2007 :param l2_table_index: (Default value = 0xFFFFFFFF)
2011 self.papi.input_acl_set_interface,
2012 {'sw_if_index': sw_if_index,
2013 'ip4_table_index': ip4_table_index,
2014 'ip6_table_index': ip6_table_index,
2015 'l2_table_index': l2_table_index,
2018 def set_ipfix_exporter(
2025 collector_port=4739,
2028 self.papi.set_ipfix_exporter,
2030 'collector_address': collector_address,
2031 'collector_port': collector_port,
2032 'src_address': src_address,
2034 'path_mtu': path_mtu,
2035 'template_interval': template_interval,
2036 'udp_checksum': udp_checksum,
2039 def dhcp_proxy_config(self,
2047 self.papi.dhcp_proxy_config,
2049 'rx_vrf_id': rx_table_id,
2050 'server_vrf_id': server_table_id,
2053 'dhcp_server': dhcp_server,
2054 'dhcp_src_address': dhcp_src_address,
2057 def dhcp_proxy_set_vss(self,
2066 self.papi.dhcp_proxy_set_vss,
2069 'vss_type': vss_type,
2070 'vpn_ascii_id': vpn_ascii_id,
2072 'vpn_index': vpn_index,
2077 def dhcp_client(self,
2082 want_dhcp_events=0):
2084 self.papi.dhcp_client_config,
2086 'sw_if_index': sw_if_index,
2087 'hostname': hostname,
2088 'client_id': client_id,
2090 'want_dhcp_event': want_dhcp_events,
2094 def ip_mroute_add_del(self,
2100 next_hop_sw_if_index,
2109 IP Multicast Route add/del
2112 self.papi.ip_mroute_add_del,
2113 {'next_hop_sw_if_index': next_hop_sw_if_index,
2114 'entry_flags': e_flags,
2115 'itf_flags': i_flags,
2116 'table_id': table_id,
2120 'is_local': is_local,
2121 'bier_imp': bier_imp,
2122 'next_hop_afi': next_hop_afi,
2123 'grp_address_length': grp_address_length,
2124 'grp_address': grp_address,
2125 'src_address': src_address})
2127 def mfib_signal_dump(self):
2128 return self.api(self.papi.mfib_signal_dump, {})
2130 def ip_mfib_dump(self):
2131 return self.api(self.papi.ip_mfib_dump, {})
2133 def ip6_mfib_dump(self):
2134 return self.api(self.papi.ip6_mfib_dump, {})
2136 def lisp_enable_disable(self, is_enabled):
2138 self.papi.lisp_enable_disable,
2140 'is_en': is_enabled,
2143 def lisp_locator_set(self,
2147 self.papi.lisp_add_del_locator_set,
2150 'locator_set_name': ls_name
2153 def lisp_locator_set_dump(self):
2154 return self.api(self.papi.lisp_locator_set_dump, {})
2156 def lisp_locator(self,
2163 self.papi.lisp_add_del_locator,
2166 'locator_set_name': ls_name,
2167 'sw_if_index': sw_if_index,
2168 'priority': priority,
2172 def lisp_locator_dump(self, is_index_set, ls_name=None, ls_index=0):
2174 self.papi.lisp_locator_dump,
2176 'is_index_set': is_index_set,
2178 'ls_index': ls_index,
2181 def lisp_local_mapping(self,
2191 self.papi.lisp_add_del_local_eid,
2193 'locator_set_name': ls_name,
2195 'eid_type': eid_type,
2197 'prefix_len': prefix_len,
2203 def lisp_eid_table_dump(self,
2211 self.papi.lisp_eid_table_dump,
2214 'prefix_length': prefix_length,
2216 'eid_type': eid_type,
2218 'filter': filter_opt,
2221 def lisp_remote_mapping(self,
2231 self.papi.lisp_add_del_remote_mapping,
2234 'eid_type': eid_type,
2236 'eid_len': eid_prefix_len,
2237 'rloc_num': rlocs_num,
2240 'is_src_dst': is_src_dst,
2243 def lisp_adjacency(self,
2252 self.papi.lisp_add_del_adjacency,
2256 'eid_type': eid_type,
2259 'leid_len': leid_len,
2260 'reid_len': reid_len,
2263 def lisp_adjacencies_get(self, vni=0):
2265 self.papi.lisp_adjacencies_get,
2270 def map_add_domain(self,
2283 self.papi.map_add_domain,
2285 'ip6_prefix': ip6_prefix,
2286 'ip6_prefix_len': ip6_prefix_len,
2287 'ip4_prefix': ip4_prefix,
2288 'ip4_prefix_len': ip4_prefix_len,
2290 'ip6_src_prefix_len': ip6_src_prefix_len,
2291 'ea_bits_len': ea_bits_len,
2292 'psid_offset': psid_offset,
2293 'psid_length': psid_length,
2294 'is_translation': is_translation,
2298 def gtpu_add_del_tunnel(
2304 mcast_sw_if_index=0xFFFFFFFF,
2306 decap_next_index=0xFFFFFFFF,
2310 :param is_add: (Default value = 1)
2311 :param is_ipv6: (Default value = 0)
2314 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2315 :param encap_vrf_id: (Default value = 0)
2316 :param decap_next_index: (Default value = 0xFFFFFFFF)
2317 :param teid: (Default value = 0)
2320 return self.api(self.papi.gtpu_add_del_tunnel,
2323 'src_address': src_addr,
2324 'dst_address': dst_addr,
2325 'mcast_sw_if_index': mcast_sw_if_index,
2326 'encap_vrf_id': encap_vrf_id,
2327 'decap_next_index': decap_next_index,
2330 def vxlan_gpe_add_del_tunnel(
2334 mcast_sw_if_index=0xFFFFFFFF,
2345 :param is_add: (Default value = 1)
2346 :param is_ipv6: (Default value = 0)
2347 :param encap_vrf_id: (Default value = 0)
2348 :param decap_vrf_id: (Default value = 0)
2349 :param mcast_sw_if_index: (Default value = 0xFFFFFFFF)
2350 :param protocol: (Default value = 3)
2351 :param vni: (Default value = 0)
2354 return self.api(self.papi.vxlan_gpe_add_del_tunnel,
2359 'mcast_sw_if_index': mcast_sw_if_index,
2360 'encap_vrf_id': encap_vrf_id,
2361 'decap_vrf_id': decap_vrf_id,
2362 'protocol': protocol,
2365 def pppoe_add_del_session(
2375 :param is_add: (Default value = 1)
2376 :param is_ipv6: (Default value = 0)
2378 :param session_id: (Default value = 0)
2380 :param decap_vrf_id: (Default value = 0)
2383 return self.api(self.papi.pppoe_add_del_session,
2386 'session_id': session_id,
2387 'client_ip': client_ip,
2388 'decap_vrf_id': decap_vrf_id,
2389 'client_mac': client_mac})
2391 def sr_localsid_add_del(self,
2397 sw_if_index=0xFFFFFFFF,
2401 """ Add/del IPv6 SR local-SID.
2403 :param localsid_addr:
2404 :param behavior: END=1; END.X=2; END.DX2=4; END.DX6=5;
2405 :param behavior: END.DX4=6; END.DT6=7; END.DT4=8
2407 :param is_del: (Default value = 0)
2408 :param end_psp: (Default value = 0)
2409 :param sw_if_index: (Default value = 0xFFFFFFFF)
2410 :param vlan_index: (Default value = 0)
2411 :param fib_table: (Default value = 0)
2414 self.papi.sr_localsid_add_del,
2416 'localsid_addr': localsid_addr,
2418 'behavior': behavior,
2419 'sw_if_index': sw_if_index,
2420 'vlan_index': vlan_index,
2421 'fib_table': fib_table,
2436 :param bsid_addr: bindingSID of the SR Policy
2437 :param weight: weight of the sid list. optional. (default: 1)
2438 :param is_encap: (bool) whether SR policy should Encap or SRH insert \
2440 :param type: type/behavior of the SR policy. (default or spray) \
2442 :param fib_table: VRF where to install the FIB entry for the BSID \
2444 :param n_segments: number of segments \
2446 :param segments: a vector of IPv6 address composing the segment list \
2450 self.papi.sr_policy_add,
2451 {'bsid_addr': bsid_addr,
2453 'is_encap': is_encap,
2455 'fib_table': fib_table,
2456 'n_segments': n_segments,
2457 'segments': segments
2466 :param bsid: bindingSID of the SR Policy
2467 :param sr_policy_index: index of the sr policy (default: 0)
2470 self.papi.sr_policy_del,
2471 {'bsid_addr': bsid_addr,
2472 'sr_policy_index': sr_policy_index
2475 def sr_steering_add_del(
2486 Steer traffic L2 and L3 traffic through a given SR policy
2488 :param is_del: delete or add
2489 :param bsid_addr: bindingSID of the SR Policy (alt to sr_policy_index)
2490 :param sr_policy: is the index of the SR Policy (alt to bsid)
2491 :param table_id: is the VRF where to install the FIB entry for the BSID
2492 :param prefix_addr: is the IPv4/v6 address for L3 traffic type
2493 :param mask_width: is the mask for L3 traffic type
2494 :param sw_if_index: is the incoming interface for L2 traffic
2495 :param traffic_type: type of traffic (IPv4: 4, IPv6: 6, L2: 2)
2498 self.papi.sr_steering_add_del,
2500 'bsid_addr': bsid_addr,
2501 'sr_policy_index': sr_policy_index,
2502 'table_id': table_id,
2503 'prefix_addr': prefix_addr,
2504 'mask_width': mask_width,
2505 'sw_if_index': sw_if_index,
2506 'traffic_type': traffic_type
2509 def acl_add_replace(self, acl_index, r, tag='',
2511 """Add/replace an ACL
2512 :param int acl_index: ACL index to replace, 2^32-1 to create new ACL.
2513 :param acl_rule r: ACL rules array.
2514 :param str tag: symbolic tag (description) for this ACL.
2515 :param int count: number of rules.
2517 return self.api(self.papi.acl_add_replace,
2518 {'acl_index': acl_index,
2522 expected_retval=expected_retval)
2524 def acl_del(self, acl_index, expected_retval=0):
2530 return self.api(self.papi.acl_del,
2531 {'acl_index': acl_index},
2532 expected_retval=expected_retval)
2534 def acl_interface_set_acl_list(self, sw_if_index, n_input, acls,
2536 return self.api(self.papi.acl_interface_set_acl_list,
2537 {'sw_if_index': sw_if_index,
2541 expected_retval=expected_retval)
2543 def acl_interface_add_del(self,
2547 """ Add/Delete ACL to/from interface
2551 :param is_add: (Default value = 1)
2554 return self.api(self.papi.acl_interface_add_del,
2557 'sw_if_index': sw_if_index,
2558 'acl_index': acl_index})
2560 def acl_dump(self, acl_index, expected_retval=0):
2561 return self.api(self.papi.acl_dump,
2562 {'acl_index': acl_index},
2563 expected_retval=expected_retval)
2565 def macip_acl_add(self, rules, tag=""):
2568 :param rules: list of rules for given acl
2572 return self.api(self.papi.macip_acl_add,
2574 'count': len(rules),
2577 def macip_acl_add_replace(self, rules, acl_index=0xFFFFFFFF, tag=""):
2580 :param rules: list of rules for given acl
2584 return self.api(self.papi.macip_acl_add_replace,
2585 {'acl_index': acl_index,
2587 'count': len(rules),
2590 def macip_acl_del(self, acl_index):
2596 return self.api(self.papi.macip_acl_del,
2597 {'acl_index': acl_index})
2599 def macip_acl_interface_add_del(self,
2603 """ Add MACIP acl to interface
2607 :param is_add: (Default value = 1)
2610 return self.api(self.papi.macip_acl_interface_add_del,
2612 'sw_if_index': sw_if_index,
2613 'acl_index': acl_index})
2615 def macip_acl_interface_get(self):
2616 """ Return interface acls dump
2619 self.papi.macip_acl_interface_get, {})
2621 def macip_acl_dump(self, acl_index=4294967295):
2622 """ Return MACIP acl dump
2626 self.papi.macip_acl_dump, {'acl_index': acl_index})
2628 def policer_add_del(self,
2639 conform_action_type=1,
2641 exceed_action_type=0,
2643 violate_action_type=0,
2645 return self.api(self.papi.policer_add_del,
2652 'rate_type': rate_type,
2653 'round_type': round_type,
2655 'color_aware': color_aware,
2656 'conform_action_type': conform_action_type,
2657 'conform_dscp': conform_dscp,
2658 'exceed_action_type': exceed_action_type,
2659 'exceed_dscp': exceed_dscp,
2660 'violate_action_type': violate_action_type,
2661 'violate_dscp': violate_dscp})
2663 def ip_punt_police(self,
2667 return self.api(self.papi.ip_punt_police,
2668 {'policer_index': policer_index,
2672 def ip_punt_redirect(self,
2678 return self.api(self.papi.ip_punt_redirect,
2679 {'rx_sw_if_index': rx_sw_if_index,
2680 'tx_sw_if_index': tx_sw_if_index,
2685 def bier_table_add_del(self,
2689 """ BIER Table add/del """
2691 self.papi.bier_table_add_del,
2692 {'bt_tbl_id': {"bt_set": bti.set_id,
2693 "bt_sub_domain": bti.sub_domain_id,
2694 "bt_hdr_len_id": bti.hdr_len_id},
2695 'bt_label': mpls_label,
2696 'bt_is_add': is_add})
2698 def bier_table_dump(self):
2699 return self.api(self.papi.bier_table_dump, {})
2701 def bier_route_add_del(self,
2706 """ BIER Route add/del """
2709 br_paths.append({'next_hop': p.nh_addr,
2713 'table_id': p.nh_table_id,
2714 'next_hop_id': p.next_hop_id,
2715 'is_udp_encap': p.is_udp_encap,
2716 'n_labels': len(p.nh_labels),
2717 'label_stack': p.nh_labels})
2719 self.papi.bier_route_add_del,
2720 {'br_tbl_id': {"bt_set": bti.set_id,
2721 "bt_sub_domain": bti.sub_domain_id,
2722 "bt_hdr_len_id": bti.hdr_len_id},
2724 'br_n_paths': len(br_paths),
2725 'br_paths': br_paths,
2726 'br_is_add': is_add})
2728 def bier_route_dump(self, bti):
2730 self.papi.bier_route_dump,
2731 {'br_tbl_id': {"bt_set": bti.set_id,
2732 "bt_sub_domain": bti.sub_domain_id,
2733 "bt_hdr_len_id": bti.hdr_len_id}})
2735 def bier_imp_add(self,
2740 """ BIER Imposition Add """
2742 self.papi.bier_imp_add,
2743 {'bi_tbl_id': {"bt_set": bti.set_id,
2744 "bt_sub_domain": bti.sub_domain_id,
2745 "bt_hdr_len_id": bti.hdr_len_id},
2747 'bi_n_bytes': len(ibytes),
2748 'bi_bytes': ibytes})
2750 def bier_imp_del(self, bi_index):
2751 """ BIER Imposition del """
2753 self.papi.bier_imp_del,
2754 {'bi_index': bi_index})
2756 def bier_imp_dump(self):
2757 return self.api(self.papi.bier_imp_dump, {})
2759 def bier_disp_table_add_del(self,
2762 """ BIER Disposition Table add/del """
2764 self.papi.bier_disp_table_add_del,
2765 {'bdt_tbl_id': bdti,
2766 'bdt_is_add': is_add})
2768 def bier_disp_table_dump(self):
2769 return self.api(self.papi.bier_disp_table_dump, {})
2771 def bier_disp_entry_add_del(self,
2780 """ BIER Route add/del """
2782 self.papi.bier_disp_entry_add_del,
2783 {'bde_tbl_id': bdti,
2785 'bde_payload_proto': payload_proto,
2787 'bde_paths': [{'next_hop': next_hop,
2788 'table_id': next_hop_tbl_id,
2790 'rpf_id': next_hop_rpf_id,
2792 'label_stack': [0]}],
2793 'bde_is_add': is_add})
2795 def bier_disp_entry_dump(self, bdti):
2797 self.papi.bier_disp_entry_dump,
2798 {'bde_tbl_id': bdti})
2800 def add_node_next(self, node_name, next_name):
2801 """ Set the next node for a given node request
2806 return self.api(self.papi.add_node_next,
2807 {'node_name': node_name,
2808 'next_name': next_name})
2810 def session_enable_disable(self, is_enabled):
2812 self.papi.session_enable_disable,
2813 {'is_enable': is_enabled})
2815 def ipsec_spd_add_del(self, spd_id, is_add=1):
2816 """ SPD add/del - Wrapper to add or del ipsec SPD
2817 Sample CLI : 'ipsec spd add 1'
2819 :param spd_id - SPD ID to be created in the vpp . mandatory
2820 :param is_add - create (1) or delete(0) SPD (Default 1 - add) .
2822 :returns: reply from the API
2825 self.papi.ipsec_spd_add_del, {
2826 'spd_id': spd_id, 'is_add': is_add})
2828 def ipsec_interface_add_del_spd(self, spd_id, sw_if_index, is_add=1):
2829 """ IPSEC interface SPD add/del - \
2830 Wrapper to associate/disassociate SPD to interface in VPP
2831 Sample CLI : 'set interface ipsec spd GigabitEthernet0/6/0 1'
2833 :param spd_id - SPD ID to associate with the interface . mandatory
2834 :param sw_if_index - Interface Index which needs to ipsec \
2835 association mandatory
2836 :param is_add - add(1) or del(0) association with interface \
2837 (Default 1 - add) . optional
2838 :returns: reply from the API
2841 self.papi.ipsec_interface_add_del_spd, {
2843 'sw_if_index': sw_if_index, 'is_add': is_add})
2845 def ipsec_sad_add_del_entry(self,
2848 tunnel_src_address='',
2849 tunnel_dst_address='',
2851 integrity_algorithm=2,
2852 integrity_key_length=0,
2853 integrity_key='C91KUR9GYMm5GfkEvNjX',
2855 crypto_key_length=0,
2856 crypto_key='JPjyOWBeVEQiMe7h',
2859 """ IPSEC SA add/del
2860 Sample CLI : 'ipsec sa add 10 spi 1001 esp \
2861 crypto-key 4a506a794f574265564551694d653768 \
2862 crypto-alg aes-cbc-128 \
2863 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
2864 integ-alg sha1-96 tunnel-src 192.168.100.3 \
2865 tunnel-dst 192.168.100.2'
2866 Sample CLI : 'ipsec sa add 20 spi 2001 \
2867 integ-key 4339314b55523947594d6d3547666b45764e6a58 \
2870 :param sad_id - Security Association ID to be \
2871 created or deleted. mandatory
2872 :param spi - security param index of the SA in decimal. mandatory
2873 :param tunnel_src_address - incase of tunnel mode outer src address .\
2874 mandatory for tunnel mode
2875 :param tunnel_dst_address - incase of transport mode \
2876 outer dst address. mandatory for tunnel mode
2877 :param protocol - AH(0) or ESP(1) protocol (Default 0 - AH). optional
2878 :param integrity_algorithm - value range 1-6 Default(2 - SHA1_96).\
2880 :param integrity_key - value in string \
2881 (Default C91KUR9GYMm5GfkEvNjX).optional
2882 :param integrity_key_length - length of the key string in bytes\
2883 (Default 0 - integrity disabled). optional
2884 :param crypto_algorithm - value range 1-11 Default \
2885 (1- AES_CBC_128).optional **
2886 :param crypto_key - value in string(Default JPjyOWBeVEQiMe7h).optional
2887 :param crypto_key_length - length of the key string in bytes\
2888 (Default 0 - crypto disabled). optional
2889 :param is_add - add(1) or del(0) ipsec SA entry(Default 1 - add) .\
2891 :param is_tunnel - tunnel mode (1) or transport mode(0) \
2892 (Default 1 - tunnel). optional
2893 :returns: reply from the API
2894 :** reference /vpp/src/vnet/ipsec/ipsec.h file for enum values of
2895 crypto and ipsec algorithms
2898 self.papi.ipsec_sad_add_del_entry,
2901 'tunnel_src_address': tunnel_src_address,
2902 'tunnel_dst_address': tunnel_dst_address,
2903 'protocol': protocol,
2904 'integrity_algorithm': integrity_algorithm,
2905 'integrity_key_length': integrity_key_length,
2906 'integrity_key': integrity_key,
2907 'crypto_algorithm': crypto_algorithm,
2908 'crypto_key_length': crypto_key_length,
2909 'crypto_key': crypto_key,
2911 'is_tunnel': is_tunnel})
2913 def ipsec_spd_add_del_entry(self,
2915 local_address_start,
2917 remote_address_start,
2918 remote_address_stop,
2920 local_port_stop=65535,
2921 remote_port_start=0,
2922 remote_port_stop=65535,
2930 """ IPSEC policy SPD add/del -
2931 Wrapper to configure ipsec SPD policy entries in VPP
2932 Sample CLI : 'ipsec policy add spd 1 inbound priority 10 action \
2933 protect sa 20 local-ip-range 192.168.4.4 - 192.168.4.4 \
2934 remote-ip-range 192.168.3.3 - 192.168.3.3'
2936 :param spd_id - SPD ID for the policy . mandatory
2937 :param local_address_start - local-ip-range start address . mandatory
2938 :param local_address_stop - local-ip-range stop address . mandatory
2939 :param remote_address_start - remote-ip-range start address . mandatory
2940 :param remote_address_stop - remote-ip-range stop address . mandatory
2941 :param local_port_start - (Default 0) . optional
2942 :param local_port_stop - (Default 65535). optional
2943 :param remote_port_start - (Default 0). optional
2944 :param remote_port_stop - (Default 65535). optional
2945 :param protocol - Any(0), AH(51) & ESP(50) protocol (Default 0 - Any).
2947 :param sa_id - Security Association ID for mapping it to SPD
2948 (default 10). optional
2949 :param policy - bypass(0), discard(1), resolve(2) or protect(3)action
2950 (Default 0 - bypass). optional
2951 :param priotity - value for the spd action (Default 100). optional
2952 :param is_outbound - flag for inbound(0) or outbound(1)
2953 (Default 1 - outbound). optional
2954 :param is_add flag - for addition(1) or deletion(0) of the spd
2955 (Default 1 - addtion). optional
2956 :returns: reply from the API
2959 self.papi.ipsec_spd_add_del_entry,
2961 'local_address_start': local_address_start,
2962 'local_address_stop': local_address_stop,
2963 'remote_address_start': remote_address_start,
2964 'remote_address_stop': remote_address_stop,
2965 'local_port_start': local_port_start,
2966 'local_port_stop': local_port_stop,
2967 'remote_port_start': remote_port_start,
2968 'remote_port_stop': remote_port_stop,
2970 'protocol': protocol,
2972 'priority': priority,
2973 'is_outbound': is_outbound,
2975 'is_ip_any': is_ip_any})