-# Copyright (c) 2016 Cisco and/or its affiliates.
+# Copyright (c) 2018 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
:param prefix_length: Length of network prefix.
:type prefix_length: int
-
- :return: Network mask.
+ :returns: Network mask.
:rtype: str
"""
:type interface: str
:type address: str
:type prefix_length: int
- :return: nothing
+ :returns: nothing
"""
pass
@abstractmethod
- def set_route(self, network, prefix_length, gateway, interface):
+ def set_route(self, network, prefix_length, gateway, interface, count=1):
"""Configure IPv4 route.
:param network: Network IPv4 address.
:param prefix_length: IPv4 prefix length.
:param gateway: IPv4 address of the gateway.
:param interface: Interface name.
+ :param count: Number of consecutive routes to add.
:type network: str
:type prefix_length: int
:type gateway: str
:type interface: str
- :return: nothing
+ :type route: int
+ :returns: nothing
"""
pass
:type prefix_length: int
:type gateway: str
:type interface: str
- :return: nothing
+ :returns: nothing
"""
pass
:param interface: Interface name.
:type interface: str
- :return: nothing
+ :returns: nothing
"""
pass
:param source_interface: Source interface name.
:type destination_address: str
:type source_interface: str
- :return: nothing
+ :returns: nothing
"""
pass
:param cmd: Command to be executed.
:type cmd: str
-
- :return: Content of stdout and stderr returned by command.
+ :returns: Content of stdout and stderr returned by command.
:rtype: tuple
"""
return exec_cmd_no_error(self.node_info, cmd)
:param cmd: Command to be executed.
:type cmd: str
-
- :return: Content of stdout and stderr returned by command.
+ :returns: Content of stdout and stderr returned by command.
:rtype: tuple
"""
return exec_cmd_no_error(self.node_info, cmd, sudo=True)
interface)
self._sudo_execute(cmd)
- def set_route(self, network, prefix_length, gateway, interface):
+ def set_route(self, network, prefix_length, gateway, interface, count=1):
netmask = self._get_netmask(prefix_length)
cmd = 'route add -net {} netmask {} gw {}'.\
format(network, netmask, gateway)
:param interface: Interface name.
:type interface: str
- :return: sw_if_index of the interface or None.
+ :returns: sw_if_index of the interface or None.
:rtype: int
"""
return Topology().get_interface_sw_index(self.node_info, interface)
:param args: Parameters to the script.
:type script: str
:type args: dict
- :return: nothing
+ :returns: nothing
"""
# TODO: check return value
VatExecutor.cmd_from_template(self.node_info, script, **args)
- def set_arp(self, iface_key, ip_address, mac_address, vrf=None):
+ def set_arp(self, iface_key, ip_address, mac_address):
"""Set entry in ARP cache.
:param iface_key: Interface key.
:param ip_address: IP address.
:param mac_address: MAC address.
- :param vrf: VRF table ID (Optional).
:type iface_key: str
:type ip_address: str
:type mac_address: str
- :type vrf: int
"""
- vrf = "vrf {}".format(vrf) if vrf else ''
self.exec_vat('add_ip_neighbor.vat',
sw_if_index=self.get_sw_if_index(iface_key),
- ip_address=ip_address, mac_address=mac_address,
- vrf=vrf)
+ ip_address=ip_address, mac_address=mac_address)
def set_ip(self, interface, address, prefix_length):
self.exec_vat('add_ip_address.vat',
:param node_info: Dictionary containing information on nodes in topology.
:type node_info: dict
- :return: Class instance that is derived from Node.
+ :returns: Class instance that is derived from Node.
"""
if node_info['type'] == NodeType.TG:
return Tg(node_info)
:param nodes_addr: Available nodes IPv4 addresses.
:type nodes: dict
:type nodes_addr: dict
- :return: Affected interfaces as list of (node, interface) tuples.
+ :returns: Affected interfaces as list of (node, interface) tuples.
:rtype: list
"""
interfaces = []
:type node: dict
:type iface_key: str
:type nodes_addr: dict
- :return: IPv4 address.
+ :returns: IPv4 address.
:rtype: str
"""
interface = Topology.get_interface_name(node, iface_key)
interfaces from topology and use them to setup ARP entries.
:param nodes_info: Dictionary containing information on all nodes
- in topology.
+ in topology.
:param nodes_addr: Nodes IPv4 addresses.
:type nodes_info: dict
:type nodes_addr: dict
get_node(node).set_arp(iface_key, ip_address, mac_address)
@staticmethod
- def add_arp_on_dut(node, iface_key, ip_address, mac_address, vrf=None):
+ def add_arp_on_dut(node, iface_key, ip_address, mac_address):
"""Set ARP cache entree on DUT node.
:param node: VPP Node in the topology.
:param iface_key: Interface key.
:param ip_address: IP address of the interface.
:param mac_address: MAC address of the interface.
- :param vrf: VRF table ID (Optional).
:type node: dict
:type iface_key: str
:type ip_address: str
:type mac_address: str
- :type vrf: int
"""
- get_node(node).set_arp(iface_key, ip_address, mac_address, vrf)
+ get_node(node).set_arp(iface_key, ip_address, mac_address)