1 # Copyright (c) 2017 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 """DHCP utilities for VPP."""
17 from resources.libraries.python.VatExecutor import VatExecutor
18 from resources.libraries.python.topology import Topology
21 class DhcpClient(object):
22 """DHCP Client utilities."""
25 def set_dhcp_client_on_interface(vpp_node, interface, hostname=None):
26 """Set DHCP client on interface.
28 :param vpp_node: VPP node to set DHCP client on.
29 :param interface: Interface name to set DHCP client on.
30 :param hostname: Hostname used in DHCP DISCOVER.
34 :raises RuntimeError: If unable to set DHCP client on interface.
36 sw_if_index = Topology.get_interface_sw_index(vpp_node, interface)
37 interface = 'sw_if_index {}'.format(sw_if_index)
38 hostname = 'hostname {}'.format(hostname) if hostname else ''
39 output = VatExecutor.cmd_from_template(vpp_node,
45 if output["retval"] != 0:
46 raise RuntimeError('Unable to set DHCP client on node {} and'
48 .format(vpp_node, interface))
51 class DhcpProxy(object):
52 """DHCP Proxy utilities."""
55 def dhcp_proxy_config(vpp_node, server_address, source_address):
58 :param vpp_node: VPP node to set DHCP proxy.
59 :param server_address: DHCP server IP address.
60 :param source_address: DHCP proxy address.
62 :type server_address: str
63 :type source_address: str
64 :raises RuntimeError: If unable to set DHCP proxy.
67 output = VatExecutor.cmd_from_template(vpp_node,
68 "dhcp_proxy_config.vat",
69 server_address=server_address,
70 source_address=source_address)
73 if output["retval"] != 0:
74 raise RuntimeError('Unable to set DHCP proxy on node {}'
78 def vpp_get_dhcp_proxy(node, ip_version):
79 """Retrieve DHCP relay configuration.
81 :param node: VPP node.
82 :param ip_version: IP protocol version: ipv4 or ipv6.
85 :returns: DHCP relay data.
89 return VatExecutor.cmd_from_template(
90 node, "dhcp_proxy_dump.vat",
91 ipv6="ipv6" if ip_version == "ipv6" else "")