1 # Copyright (c) 2016 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 """Routing utilities library."""
16 from resources.libraries.python.VatExecutor import VatTerminal
17 from resources.libraries.python.topology import Topology
20 class Routing(object):
21 """Routing utilities."""
24 def vpp_route_add(node, network, prefix_len, gateway=None, interface=None,
25 use_sw_index=True, resolve_attempts=10, count=1):
26 """Add route to the VPP node.
28 :param node: Node to add route on.
29 :param network: Route destination network address.
30 :param prefix_len: Route destination network prefix length.
31 :param gateway: Route gateway address.
32 :param interface: Route interface.
33 :param use_sw_index: Use sw_if_index in VAT command.
34 :param resolve_attempts: Resolve attempts IP route add parameter.
35 :param count: number of IP addresses to add starting from network IP
36 with same prefix (increment is 1)
37 If None, then is not used.
43 :type use_sw_index: bool
44 :type resolve_attempts: int
48 int_cmd = ('sw_if_index {}'.
49 format(Topology.get_interface_sw_index(node, interface)))
53 rap = 'resolve-attempts {}'.format(resolve_attempts) \
54 if resolve_attempts else ''
56 via = 'via {}'.format(gateway) if gateway else ''
58 cnt = 'count {}'.format(count) \
61 with VatTerminal(node, json_param=False) as vat:
62 vat.vat_terminal_exec_cmd_from_template('add_route.vat',
64 prefix_length=prefix_len,
71 def add_fib_table(node, network, prefix_len, fib_id, place):
72 """Create new FIB table according to ID.
74 :param node: Node to add FIB on.
75 :param network: IP address to add to the FIB table.
76 :param prefix_len: IP address prefix length.
77 :param fib_id: FIB table ID.
78 :param place: Possible variants are local, drop.
85 with VatTerminal(node) as vat:
86 vat.vat_terminal_exec_cmd_from_template('add_fib_table.vat',
88 prefix_length=prefix_len,