1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Interface util library"""
16 from time import time, sleep
18 from robot.api import logger
20 from resources.libraries.python.ssh import SSH
21 from resources.libraries.python.IPUtil import convert_ipv4_netmask_prefix
22 from resources.libraries.python.ssh import exec_cmd_no_error
23 from resources.libraries.python.topology import NodeType, Topology
24 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
25 from resources.libraries.python.VatJsonUtil import VatJsonUtil
26 from resources.libraries.python.parsers.JsonParser import JsonParser
29 class InterfaceUtil(object):
30 """General utilities for managing interfaces"""
32 __UDEV_IF_RULES_FILE = '/etc/udev/rules.d/10-network.rules'
35 def set_interface_state(node, interface, state, if_type="key"):
36 """Set interface state on a node.
38 Function can be used for DUTs as well as for TGs.
40 :param node: Node where the interface is.
41 :param interface: Interface key or sw_if_index or name.
42 :param state: One of 'up' or 'down'.
43 :param if_type: Interface type
45 :type interface: str or int
49 :raises ValueError: If the interface type is unknown.
50 :raises ValueError: If the state of interface is unexpected.
51 :raises ValueError: If the node has an unknown node type.
55 if isinstance(interface, basestring):
56 sw_if_index = Topology.get_interface_sw_index(node, interface)
57 iface_name = Topology.get_interface_name(node, interface)
59 sw_if_index = interface
60 elif if_type == "name":
61 iface_key = Topology.get_interface_by_name(node, interface)
62 if iface_key is not None:
63 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
64 iface_name = interface
66 raise ValueError("if_type unknown: {}".format(if_type))
68 if node['type'] == NodeType.DUT:
74 raise ValueError('Unexpected interface state: {}'.format(state))
75 VatExecutor.cmd_from_template(node, 'set_if_state.vat',
76 sw_if_index=sw_if_index, state=state)
77 elif node['type'] == NodeType.TG or node['type'] == NodeType.VM:
78 cmd = 'ip link set {} {}'.format(iface_name, state)
79 exec_cmd_no_error(node, cmd, sudo=True)
81 raise ValueError('Node {} has unknown NodeType: "{}"'
82 .format(node['host'], node['type']))
85 def set_interface_ethernet_mtu(node, iface_key, mtu):
86 """Set Ethernet MTU for specified interface.
88 Function can be used only for TGs.
90 :param node: Node where the interface is.
91 :param iface_key: Interface key from topology file.
92 :param mtu: MTU to set.
97 :raises ValueError: If the node type is "DUT".
98 :raises ValueError: If the node has an unknown node type.
100 if node['type'] == NodeType.DUT:
101 raise ValueError('Node {}: Setting Ethernet MTU for interface '
102 'on DUT nodes not supported', node['host'])
103 elif node['type'] == NodeType.TG:
104 iface_name = Topology.get_interface_name(node, iface_key)
105 cmd = 'ip link set {} mtu {}'.format(iface_name, mtu)
106 exec_cmd_no_error(node, cmd, sudo=True)
108 raise ValueError('Node {} has unknown NodeType: "{}"'
109 .format(node['host'], node['type']))
112 def set_default_ethernet_mtu_on_all_interfaces_on_node(node):
113 """Set default Ethernet MTU on all interfaces on node.
115 Function can be used only for TGs.
117 :param node: Node where to set default MTU.
121 for ifc in node['interfaces']:
122 InterfaceUtil.set_interface_ethernet_mtu(node, ifc, 1500)
125 def vpp_node_interfaces_ready_wait(node, timeout=10):
126 """Wait until all interfaces with admin-up are in link-up state.
128 :param node: Node to wait on.
129 :param timeout: Waiting timeout in seconds (optional, default 10s).
133 :raises RuntimeError: If the timeout period value has elapsed.
139 out = InterfaceUtil.vpp_get_interface_data(node)
140 if time() - start > timeout:
141 for interface in out:
142 if interface.get('admin_up_down') == 1:
143 if interface.get('link_up_down') != 1:
144 logger.debug('{0} link-down'.format(
145 interface.get('interface_name')))
146 raise RuntimeError('timeout, not up {0}'.format(not_ready))
148 for interface in out:
149 if interface.get('admin_up_down') == 1:
150 if interface.get('link_up_down') != 1:
151 not_ready.append(interface.get('interface_name'))
155 logger.debug('Interfaces still in link-down state: {0}, '
156 'waiting...'.format(not_ready))
160 def vpp_nodes_interfaces_ready_wait(nodes, timeout=10):
161 """Wait until all interfaces with admin-up are in link-up state for
164 :param nodes: List of nodes to wait on.
165 :param timeout: Seconds to wait per node for all interfaces to come up.
171 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
174 def all_vpp_interfaces_ready_wait(nodes, timeout=10):
175 """Wait until all interfaces with admin-up are in link-up state for all
176 nodes in the topology.
178 :param nodes: Nodes in the topology.
179 :param timeout: Seconds to wait per node for all interfaces to come up.
184 for node in nodes.values():
185 if node['type'] == NodeType.DUT:
186 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
189 def vpp_get_interface_data(node, interface=None):
190 """Get all interface data from a VPP node. If a name or
191 sw_interface_index is provided, return only data for the matching
194 :param node: VPP node to get interface data from.
195 :param interface: Numeric index or name string of a specific interface.
197 :type interface: int or str
198 :returns: List of dictionaries containing data for each interface, or a
199 single dictionary for the specified interface.
201 :raises TypeError: if the data type of interface is neither basestring
204 with VatTerminal(node) as vat:
205 response = vat.vat_terminal_exec_cmd_from_template(
206 "interface_dump.vat")
210 if interface is not None:
211 if isinstance(interface, basestring):
212 param = "interface_name"
213 elif isinstance(interface, int):
214 param = "sw_if_index"
218 if data_if[param] == interface:
224 def vpp_get_interface_name(node, sw_if_index):
225 """Get interface name for the given SW interface index from actual
228 :param node: VPP node to get interface data from.
229 :param sw_if_index: SW interface index of the specific interface.
231 :type sw_if_index: int
232 :returns: Name of the given interface.
236 if_data = InterfaceUtil.vpp_get_interface_data(node, sw_if_index)
237 if if_data['sup_sw_if_index'] != if_data['sw_if_index']:
238 if_data = InterfaceUtil.vpp_get_interface_data(
239 node, if_data['sup_sw_if_index'])
241 if_name = if_data["interface_name"]
247 def vpp_get_interface_mac(node, interface=None):
248 """Get MAC address for the given interface from actual interface dump.
250 :param node: VPP node to get interface data from.
251 :param interface: Numeric index or name string of a specific interface.
253 :type interface: int or str
254 :returns: MAC address.
258 if_data = InterfaceUtil.vpp_get_interface_data(node, interface)
259 if if_data['sup_sw_if_index'] != if_data['sw_if_index']:
260 if_data = InterfaceUtil.vpp_get_interface_data(
261 node, if_data['sup_sw_if_index'])
262 mac_data = [str(hex(item))[2:] for item in if_data['l2_address'][:6]]
264 for item in mac_data:
267 mac_data_nice.append(item)
268 mac = ":".join(mac_data_nice)
272 def vpp_get_interface_ip_addresses(node, interface, ip_version):
273 """Get list of IP addresses from an interface on a VPP node.
275 :param node: VPP node to get data from.
276 :param interface: Name of an interface on the VPP node.
277 :param ip_version: IP protocol version (ipv4 or ipv6).
280 :type ip_version: str
281 :returns: List of dictionaries, each containing IP address, subnet
282 prefix length and also the subnet mask for ipv4 addresses.
283 Note: A single interface may have multiple IP addresses assigned.
288 sw_if_index = Topology.convert_interface_reference(
289 node, interface, "sw_if_index")
291 if isinstance(interface, basestring):
292 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
296 with VatTerminal(node) as vat:
297 response = vat.vat_terminal_exec_cmd_from_template(
298 "ip_address_dump.vat", ip_version=ip_version,
299 sw_if_index=sw_if_index)
303 if ip_version == "ipv4":
305 item["netmask"] = convert_ipv4_netmask_prefix(
306 item["prefix_length"])
310 def tg_set_interface_driver(node, pci_addr, driver):
311 """Set interface driver on the TG node.
313 :param node: Node to set interface driver on (must be TG node).
314 :param pci_addr: PCI address of the interface.
315 :param driver: Driver name.
319 :raises RuntimeError: If unbinding from the current driver fails.
320 :raises RuntimeError: If binding to the new driver fails.
322 old_driver = InterfaceUtil.tg_get_interface_driver(node, pci_addr)
323 if old_driver == driver:
329 # Unbind from current driver
330 if old_driver is not None:
331 cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/unbind"'\
332 .format(pci_addr, old_driver)
333 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
334 if int(ret_code) != 0:
335 raise RuntimeError("'{0}' failed on '{1}'"
336 .format(cmd, node['host']))
338 # Bind to the new driver
339 cmd = 'sh -c "echo {0} > /sys/bus/pci/drivers/{1}/bind"'\
340 .format(pci_addr, driver)
341 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
342 if int(ret_code) != 0:
343 raise RuntimeError("'{0}' failed on '{1}'"
344 .format(cmd, node['host']))
347 def tg_get_interface_driver(node, pci_addr):
348 """Get interface driver from the TG node.
350 :param node: Node to get interface driver on (must be TG node).
351 :param pci_addr: PCI address of the interface.
354 :returns: Interface driver or None if not found.
356 :raises RuntimeError: If it is not possible to get the interface driver
357 information from the node.
360 # lspci -vmmks 0000:00:05.0
362 Class: Ethernet controller
364 Device: Virtio network device
365 SVendor: Red Hat, Inc
374 logger.trace('Try {}: Get interface driver'.format(i))
375 cmd = 'sh -c "echo 1 > /sys/bus/pci/rescan"'
376 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
377 if int(ret_code) != 0:
378 raise RuntimeError("'{0}' failed on '{1}'"
379 .format(cmd, node['host']))
381 cmd = 'lspci -vmmks {0}'.format(pci_addr)
382 (ret_code, stdout, _) = ssh.exec_command(cmd)
383 if int(ret_code) != 0:
384 raise RuntimeError("'{0}' failed on '{1}'"
385 .format(cmd, node['host']))
387 for line in stdout.splitlines():
391 (name, value) = line.split("\t", 1)
393 if name != "Driver:":
397 if name == 'Driver:':
398 return value if value else None
399 raise RuntimeError('Get interface driver for: {0}'
403 def tg_set_interfaces_udev_rules(node):
404 """Set udev rules for interfaces.
406 Create udev rules file in /etc/udev/rules.d where are rules for each
407 interface used by TG node, based on MAC interface has specific name.
408 So after unbind and bind again to kernel driver interface has same
409 name as before. This must be called after TG has set name for each
410 port in topology dictionary.
412 SUBSYSTEM=="net", ACTION=="add", ATTR{address}=="52:54:00:e1:8a:0f",
415 :param node: Node to set udev rules on (must be TG node).
417 :raises RuntimeError: If setting of udev rules fails.
422 cmd = 'rm -f {0}'.format(InterfaceUtil.__UDEV_IF_RULES_FILE)
423 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
424 if int(ret_code) != 0:
425 raise RuntimeError("'{0}' failed on '{1}'"
426 .format(cmd, node['host']))
428 for interface in node['interfaces'].values():
429 rule = 'SUBSYSTEM==\\"net\\", ACTION==\\"add\\", ATTR{address}' + \
430 '==\\"' + interface['mac_address'] + '\\", NAME=\\"' + \
431 interface['name'] + '\\"'
432 cmd = 'sh -c "echo \'{0}\' >> {1}"'.format(
433 rule, InterfaceUtil.__UDEV_IF_RULES_FILE)
434 (ret_code, _, _) = ssh.exec_command_sudo(cmd)
435 if int(ret_code) != 0:
436 raise RuntimeError("'{0}' failed on '{1}'"
437 .format(cmd, node['host']))
439 cmd = '/etc/init.d/udev restart'
440 ssh.exec_command_sudo(cmd)
443 def tg_set_interfaces_default_driver(node):
444 """Set interfaces default driver specified in topology yaml file.
446 :param node: Node to setup interfaces driver on (must be TG node).
449 for interface in node['interfaces'].values():
450 InterfaceUtil.tg_set_interface_driver(node,
451 interface['pci_address'],
455 def update_vpp_interface_data_on_node(node):
456 """Update vpp generated interface data for a given node in DICT__nodes.
458 Updates interface names, software if index numbers and any other details
459 generated specifically by vpp that are unknown before testcase run.
460 It does this by dumping interface list to JSON output from all
461 devices using vpp_api_test, and pairing known information from topology
462 (mac address/pci address of interface) to state from VPP.
464 :param node: Node selected from DICT__nodes.
467 vat_executor = VatExecutor()
468 vat_executor.execute_script_json_out("dump_interfaces.vat", node)
469 interface_dump_json = vat_executor.get_script_stdout()
470 VatJsonUtil.update_vpp_interface_data_from_json(node,
474 def update_nic_interface_names(node):
475 """Update interface names based on nic type and PCI address.
477 This method updates interface names in the same format as VPP does.
479 :param node: Node dictionary.
482 for ifc in node['interfaces'].values():
483 if_pci = ifc['pci_address'].replace('.', ':').split(':')
484 bus = '{:x}'.format(int(if_pci[1], 16))
485 dev = '{:x}'.format(int(if_pci[2], 16))
486 fun = '{:x}'.format(int(if_pci[3], 16))
487 loc = '{bus}/{dev}/{fun}'.format(bus=bus, dev=dev, fun=fun)
488 if ifc['model'] == 'Intel-XL710':
489 ifc['name'] = 'FortyGigabitEthernet{loc}'.format(loc=loc)
490 elif ifc['model'] == 'Intel-X710':
491 ifc['name'] = 'TenGigabitEthernet{loc}'.format(loc=loc)
492 elif ifc['model'] == 'Intel-X520-DA2':
493 ifc['name'] = 'TenGigabitEthernet{loc}'.format(loc=loc)
494 elif ifc['model'] == 'Cisco-VIC-1385':
495 ifc['name'] = 'FortyGigabitEthernet{loc}'.format(loc=loc)
496 elif ifc['model'] == 'Cisco-VIC-1227':
497 ifc['name'] = 'TenGigabitEthernet{loc}'.format(loc=loc)
499 ifc['name'] = 'UnknownEthernet{loc}'.format(loc=loc)
502 def update_nic_interface_names_on_all_duts(nodes):
503 """Update interface names based on nic type and PCI address on all DUTs.
505 This method updates interface names in the same format as VPP does.
507 :param nodes: Topology nodes.
510 for node in nodes.values():
511 if node['type'] == NodeType.DUT:
512 InterfaceUtil.update_nic_interface_names(node)
515 def update_tg_interface_data_on_node(node):
516 """Update interface name for TG/linux node in DICT__nodes.
519 # for dev in `ls /sys/class/net/`;
520 > do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
521 "52:54:00:9f:82:63": "eth0"
522 "52:54:00:77:ae:a9": "eth1"
523 "52:54:00:e1:8a:0f": "eth2"
524 "00:00:00:00:00:00": "lo"
526 .. note:: TODO: parse lshw -json instead
528 :param node: Node selected from DICT__nodes.
530 :raises RuntimeError: If getting of interface name and MAC fails.
532 # First setup interface driver specified in yaml file
533 InterfaceUtil.tg_set_interfaces_default_driver(node)
535 # Get interface names
539 cmd = ('for dev in `ls /sys/class/net/`; do echo "\\"`cat '
540 '/sys/class/net/$dev/address`\\": \\"$dev\\""; done;')
542 (ret_code, stdout, _) = ssh.exec_command(cmd)
543 if int(ret_code) != 0:
544 raise RuntimeError('Get interface name and MAC failed')
545 tmp = "{" + stdout.rstrip().replace('\n', ',') + "}"
546 interfaces = JsonParser().parse_data(tmp)
547 for interface in node['interfaces'].values():
548 name = interfaces.get(interface['mac_address'])
551 interface['name'] = name
553 # Set udev rules for interfaces
554 InterfaceUtil.tg_set_interfaces_udev_rules(node)
557 def iface_update_numa_node(node):
558 """For all interfaces from topology file update numa node based on
559 information from the node.
561 :param node: Node from topology.
564 :raises ValueError: If numa node ia less than 0.
565 :raises RuntimeError: If update of numa node failes.
568 for if_key in Topology.get_node_interfaces(node):
569 if_pci = Topology.get_interface_pci_addr(node, if_key)
571 cmd = "cat /sys/bus/pci/devices/{}/numa_node".format(if_pci)
573 (ret, out, _) = ssh.exec_command(cmd)
580 logger.trace('Reading numa location failed for: {0}'\
583 Topology.set_interface_numa_node(node, if_key,
587 raise RuntimeError('Update numa node failed for: {0}'\
591 def update_all_numa_nodes(nodes, skip_tg=False):
592 """For all nodes and all their interfaces from topology file update numa
593 node information based on information from the node.
595 :param nodes: Nodes in the topology.
596 :param skip_tg: Skip TG node
601 for node in nodes.values():
602 if node['type'] == NodeType.DUT:
603 InterfaceUtil.iface_update_numa_node(node)
604 elif node['type'] == NodeType.TG and not skip_tg:
605 InterfaceUtil.iface_update_numa_node(node)
608 def update_all_interface_data_on_all_nodes(nodes, skip_tg=False,
610 """Update interface names on all nodes in DICT__nodes.
612 This method updates the topology dictionary by querying interface lists
613 of all nodes mentioned in the topology dictionary.
615 :param nodes: Nodes in the topology.
616 :param skip_tg: Skip TG node
617 :param numa_node: Retrieve numa_node location.
620 :type numa_node: bool
622 for node_data in nodes.values():
623 if node_data['type'] == NodeType.DUT:
624 InterfaceUtil.update_vpp_interface_data_on_node(node_data)
625 elif node_data['type'] == NodeType.TG and not skip_tg:
626 InterfaceUtil.update_tg_interface_data_on_node(node_data)
629 if node_data['type'] == NodeType.DUT:
630 InterfaceUtil.iface_update_numa_node(node_data)
631 elif node_data['type'] == NodeType.TG and not skip_tg:
632 InterfaceUtil.iface_update_numa_node(node_data)
635 def create_vlan_subinterface(node, interface, vlan):
636 """Create VLAN subinterface on node.
638 :param node: Node to add VLAN subinterface on.
639 :param interface: Interface name on which create VLAN subinterface.
640 :param vlan: VLAN ID of the subinterface to be created.
644 :returns: Name and index of created subinterface.
646 :raises RuntimeError: if it is unable to create VLAN subinterface on the
649 iface_key = Topology.get_interface_by_name(node, interface)
650 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
652 output = VatExecutor.cmd_from_template(node, "create_vlan_subif.vat",
653 sw_if_index=sw_if_index,
655 if output[0]["retval"] == 0:
656 sw_subif_idx = output[0]["sw_if_index"]
657 logger.trace('VLAN subinterface with sw_if_index {} and VLAN ID {} '
658 'created on node {}'.format(sw_subif_idx,
660 if_key = Topology.add_new_port(node, "vlan_subif")
661 Topology.update_interface_sw_if_index(node, if_key, sw_subif_idx)
662 ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_subif_idx)
663 Topology.update_interface_name(node, if_key, ifc_name)
665 raise RuntimeError('Unable to create VLAN subinterface on node {}'
666 .format(node['host']))
668 with VatTerminal(node, False) as vat:
669 vat.vat_terminal_exec_cmd('exec show interfaces')
671 return '{}.{}'.format(interface, vlan), sw_subif_idx
674 def create_vxlan_interface(node, vni, source_ip, destination_ip):
675 """Create VXLAN interface and return sw if index of created interface.
677 Executes "vxlan_add_del_tunnel src {src} dst {dst} vni {vni}" VAT
680 :param node: Node where to create VXLAN interface.
681 :param vni: VXLAN Network Identifier.
682 :param source_ip: Source IP of a VXLAN Tunnel End Point.
683 :param destination_ip: Destination IP of a VXLAN Tunnel End Point.
687 :type destination_ip: str
688 :returns: SW IF INDEX of created interface.
690 :raises RuntimeError: if it is unable to create VxLAN interface on the
693 output = VatExecutor.cmd_from_template(node, "vxlan_create.vat",
699 if output["retval"] == 0:
700 sw_if_idx = output["sw_if_index"]
701 if_key = Topology.add_new_port(node, "vxlan_tunnel")
702 Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
703 ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
704 Topology.update_interface_name(node, if_key, ifc_name)
707 raise RuntimeError("Unable to create VXLAN interface on node {0}"
711 def vxlan_dump(node, interface=None):
712 """Get VxLAN data for the given interface.
714 :param node: VPP node to get interface data from.
715 :param interface: Numeric index or name string of a specific interface.
716 If None, information about all VxLAN interfaces is returned.
718 :type interface: int or str
719 :returns: Dictionary containing data for the given VxLAN interface or if
720 interface=None, the list of dictionaries with all VxLAN interfaces.
722 :raises TypeError: if the data type of interface is neither basestring
725 param = "sw_if_index"
726 if interface is None:
729 elif isinstance(interface, basestring):
730 sw_if_index = Topology.get_interface_sw_index(node, interface)
731 elif isinstance(interface, int):
732 sw_if_index = interface
734 raise TypeError("Wrong interface format {0}".format(interface))
736 with VatTerminal(node) as vat:
737 response = vat.vat_terminal_exec_cmd_from_template(
738 "vxlan_dump.vat", param=param, sw_if_index=sw_if_index)
741 for vxlan in response[0]:
742 if vxlan["sw_if_index"] == sw_if_index:
748 def vhost_user_dump(node):
749 """Get vhost-user data for the given node.
751 :param node: VPP node to get interface data from.
753 :returns: List of dictionaries with all vhost-user interfaces.
756 with VatTerminal(node) as vat:
757 response = vat.vat_terminal_exec_cmd_from_template(
758 "vhost_user_dump.vat")
763 def tap_dump(node, name=None):
764 """Get all TAP interface data from the given node, or data about
765 a specific TAP interface.
767 :param node: VPP node to get data from.
768 :param name: Optional name of a specific TAP interface.
771 :returns: Dictionary of information about a specific TAP interface, or
772 a List of dictionaries containing all TAP data for the given node.
775 with VatTerminal(node) as vat:
776 response = vat.vat_terminal_exec_cmd_from_template(
781 for item in response[0]:
782 if name == item['dev_name']:
787 def create_subinterface(node, interface, sub_id, outer_vlan_id=None,
788 inner_vlan_id=None, type_subif=None):
789 """Create sub-interface on node. It is possible to set required
790 sub-interface type and VLAN tag(s).
792 :param node: Node to add sub-interface.
793 :param interface: Interface name on which create sub-interface.
794 :param sub_id: ID of the sub-interface to be created.
795 :param outer_vlan_id: Optional outer VLAN ID.
796 :param inner_vlan_id: Optional inner VLAN ID.
797 :param type_subif: Optional type of sub-interface. Values supported by
798 VPP: [no_tags] [one_tag] [two_tags] [dot1ad] [exact_match]
801 :type interface: str or int
803 :type outer_vlan_id: int
804 :type inner_vlan_id: int
805 :type type_subif: str
806 :returns: Name and index of created sub-interface.
808 :raises RuntimeError: If it is not possible to create sub-interface.
811 outer_vlan_id = 'outer_vlan_id {0}'.format(outer_vlan_id)\
812 if outer_vlan_id else ''
814 inner_vlan_id = 'inner_vlan_id {0}'.format(inner_vlan_id)\
815 if inner_vlan_id else ''
817 if type_subif is None:
820 if isinstance(interface, basestring):
821 iface_key = Topology.get_interface_by_name(node, interface)
822 sw_if_index = Topology.get_interface_sw_index(node, iface_key)
824 sw_if_index = interface
826 output = VatExecutor.cmd_from_template(node, "create_sub_interface.vat",
827 sw_if_index=sw_if_index,
829 outer_vlan_id=outer_vlan_id,
830 inner_vlan_id=inner_vlan_id,
831 type_subif=type_subif)
833 if output[0]["retval"] == 0:
834 sw_subif_idx = output[0]["sw_if_index"]
835 logger.trace('Created subinterface with index {}'
836 .format(sw_subif_idx))
837 if_key = Topology.add_new_port(node, "subinterface")
838 Topology.update_interface_sw_if_index(node, if_key, sw_subif_idx)
839 ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_subif_idx)
840 Topology.update_interface_name(node, if_key, ifc_name)
842 raise RuntimeError('Unable to create sub-interface on node {}'
843 .format(node['host']))
845 with VatTerminal(node, json_param=False) as vat:
846 vat.vat_terminal_exec_cmd('exec show interfaces')
848 name = '{}.{}'.format(interface, sub_id)
849 return name, sw_subif_idx
852 def create_gre_tunnel_interface(node, source_ip, destination_ip):
853 """Create GRE tunnel interface on node.
855 :param node: VPP node to add tunnel interface.
856 :param source_ip: Source of the GRE tunnel.
857 :param destination_ip: Destination of the GRE tunnel.
860 :type destination_ip: str
861 :returns: Name and index of created GRE tunnel interface.
863 :raises RuntimeError: If unable to create GRE tunnel interface.
865 output = VatExecutor.cmd_from_template(node, "create_gre.vat",
870 if output["retval"] == 0:
871 sw_if_idx = output["sw_if_index"]
873 vat_executor = VatExecutor()
874 vat_executor.execute_script_json_out("dump_interfaces.vat", node)
875 interface_dump_json = vat_executor.get_script_stdout()
876 name = VatJsonUtil.get_interface_name_from_json(
877 interface_dump_json, sw_if_idx)
879 if_key = Topology.add_new_port(node, "gre_tunnel")
880 Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
881 Topology.update_interface_name(node, if_key, name)
883 return name, sw_if_idx
885 raise RuntimeError('Unable to create GRE tunnel on node {}.'
889 def vpp_create_loopback(node):
890 """Create loopback interface on VPP node.
892 :param node: Node to create loopback interface on.
894 :returns: SW interface index.
896 :raises RuntimeError: If it is not possible to create loopback on the
899 out = VatExecutor.cmd_from_template(node, "create_loopback.vat")
900 if out[0].get('retval') == 0:
901 sw_if_idx = out[0].get('sw_if_index')
902 if_key = Topology.add_new_port(node, "loopback")
903 Topology.update_interface_sw_if_index(node, if_key, sw_if_idx)
904 ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_idx)
905 Topology.update_interface_name(node, if_key, ifc_name)
908 raise RuntimeError('Create loopback failed on node "{}"'
909 .format(node['host']))
912 def vpp_enable_input_acl_interface(node, interface, ip_version,
914 """Enable input acl on interface.
916 :param node: VPP node to setup interface for input acl.
917 :param interface: Interface to setup input acl.
918 :param ip_version: Version of IP protocol.
919 :param table_index: Classify table index.
921 :type interface: str or int
922 :type ip_version: str
923 :type table_index: int
925 if isinstance(interface, basestring):
926 sw_if_index = Topology.get_interface_sw_index(node, interface)
928 sw_if_index = interface
930 with VatTerminal(node) as vat:
931 vat.vat_terminal_exec_cmd_from_template("input_acl_int.vat",
932 sw_if_index=sw_if_index,
933 ip_version=ip_version,
934 table_index=table_index)
937 def get_interface_classify_table(node, interface):
938 """Get name of classify table for the given interface.
940 :param node: VPP node to get data from.
941 :param interface: Name or sw_if_index of a specific interface.
943 :type interface: str or int
944 :returns: Classify table name.
947 if isinstance(interface, basestring):
948 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
950 sw_if_index = interface
952 with VatTerminal(node) as vat:
953 data = vat.vat_terminal_exec_cmd_from_template(
954 "classify_interface_table.vat",
955 sw_if_index=sw_if_index)
959 def get_interface_vrf_table(node, interface):
960 """Get vrf ID for the given interface.
962 :param node: VPP node.
963 :param interface: Name or sw_if_index of a specific interface.
965 :type interface: str or int
966 :returns: vrf ID of the specified interface.
970 if isinstance(interface, basestring):
971 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
973 sw_if_index = interface
975 with VatTerminal(node) as vat:
976 data = vat.vat_terminal_exec_cmd_from_template(
977 "interface_vrf_dump.vat",
978 sw_if_index=sw_if_index)
979 return data[0]["vrf_id"]
982 def get_sw_if_index(node, interface_name):
983 """Get sw_if_index for the given interface from actual interface dump.
985 :param node: VPP node to get interface data from.
986 :param interface_name: Name of the specific interface.
988 :type interface_name: str
989 :returns: sw_if_index of the given interface.
993 with VatTerminal(node) as vat:
994 if_data = vat.vat_terminal_exec_cmd_from_template(
995 "interface_dump.vat")
996 for interface in if_data[0]:
997 if interface["interface_name"] == interface_name:
998 return interface["sw_if_index"]
1003 def vxlan_gpe_dump(node, interface_name=None):
1004 """Get VxLAN GPE data for the given interface.
1006 :param node: VPP node to get interface data from.
1007 :param interface_name: Name of the specific interface. If None,
1008 information about all VxLAN GPE interfaces is returned.
1010 :type interface_name: str
1011 :returns: Dictionary containing data for the given VxLAN GPE interface
1012 or if interface=None, the list of dictionaries with all VxLAN GPE
1014 :rtype: dict or list
1017 with VatTerminal(node) as vat:
1018 vxlan_gpe_data = vat.vat_terminal_exec_cmd_from_template(
1019 "vxlan_gpe_dump.vat")
1022 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface_name)
1024 for vxlan_gpe in vxlan_gpe_data[0]:
1025 if vxlan_gpe["sw_if_index"] == sw_if_index:
1029 return vxlan_gpe_data[0]
1032 def vpp_proxy_arp_interface_enable(node, interface):
1033 """Enable proxy ARP on interface.
1035 :param node: VPP node to enable proxy ARP on interface.
1036 :param interface: Interface to enable proxy ARP.
1038 :type interface: str or int
1040 if isinstance(interface, basestring):
1041 sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
1043 sw_if_index = interface
1045 with VatTerminal(node) as vat:
1046 vat.vat_terminal_exec_cmd_from_template(
1047 "proxy_arp_intfc_enable.vat",
1048 sw_if_index=sw_if_index)
1051 def vpp_ip_source_check_setup(node, interface):
1052 """Setup Reverse Path Forwarding source check on interface.
1054 :param node: Node to setup RPF source check.
1055 :param interface: Interface name to setup RPF source check.
1057 :type interface: str
1059 with VatTerminal(node) as vat:
1060 vat.vat_terminal_exec_cmd_from_template("ip_source_check.vat",
1061 interface_name=interface)
1064 def assign_interface_to_fib_table(node, interface, table_id, ipv6=False):
1065 """Assign VPP interface to specific VRF/FIB table.
1067 :param node: VPP node where the FIB and interface are located.
1068 :param interface: Interface to be assigned to FIB.
1069 :param table_id: VRF table ID.
1070 :param ipv6: Assign to IPv6 table. Default False.
1072 :type interface: str or int
1076 if isinstance(interface, basestring):
1077 sw_if_index = Topology.get_interface_sw_index(node, interface)
1079 sw_if_index = interface
1081 ipv6 = 'ipv6' if ipv6 else ''
1083 with VatTerminal(node) as vat:
1084 ret = vat.vat_terminal_exec_cmd_from_template(
1085 "set_fib_to_interface.vat",
1086 sw_index=sw_if_index, vrf=table_id, ipv6=ipv6)
1088 if ret[0]["retval"] != 0:
1089 raise RuntimeError('Unable to assign interface to FIB node {}.'
1093 def set_linux_interface_mac(node, interface, mac, namespace=None):
1094 """Set MAC address for interface in linux.
1096 :param node: Node where to execute command.
1097 :param interface: Interface in namespace.
1098 :param mac: MAC to be assigned to interface.
1099 :param namespace: Execute command in namespace. Optional
1101 :type interface: str
1103 :type namespace: str
1105 if namespace is not None:
1106 cmd = 'ip netns exec {} ip link set {} address {}'.format(
1107 namespace, interface, mac)
1109 cmd = 'ip link set {} address {}'.format(interface, mac)
1110 exec_cmd_no_error(node, cmd, sudo=True)