resources/libraries/python/Dhcp.py

   1 # Copyright (c) 2019 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:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   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.
  13
  14 """DHCP utilities for VPP."""
  15
  16
  17 from resources.libraries.python.PapiExecutor import PapiSocketExecutor
  18
  19
  20 class DhcpProxy:
  21     """DHCP Proxy utilities."""
  22
  23     @staticmethod
  24     def vpp_get_dhcp_proxy(node, ip_version):
  25         """Retrieve DHCP relay configuration.
  26
  27         :param node: VPP node.
  28         :param ip_version: IP protocol version: ipv4 or ipv6.
  29         :type node: dict
  30         :type ip_version: str
  31         :returns: DHCP relay data.
  32         :rtype: list
  33         """
  34         cmd = u"dhcp_proxy_dump"
  35         args = dict(is_ip6=1 if ip_version == u"ipv6" else 0)
  36         err_msg = f"Failed to get DHCP proxy dump on host {node[u'host']}"
  37
  38         with PapiSocketExecutor(node) as papi_exec:
  39             details = papi_exec.add(cmd, **args).get_details(err_msg)
  40
  41         return details