Source code for ironic.dhcp.base

# Copyright 2014 Rackspace, Inc.
# All Rights Reserved
#    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
#    Unless required by applicable law or agreed to in writing, software
#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
#    License for the specific language governing permissions and limitations
#    under the License.

Abstract base class for dhcp providers.

import abc

from oslo_log import log as logging

LOG = logging.getLogger(__name__)

[docs] class BaseDHCP(object, metaclass=abc.ABCMeta): """Base class for DHCP provider APIs."""
[docs] @abc.abstractmethod def update_port_dhcp_opts(self, port_id, dhcp_options, token=None, context=None): """Update one or more DHCP options on the specified port. :param port_id: designate which port these attributes will be applied to. :param dhcp_options: this will be a list of dicts, e.g. :: [{'opt_name': '67', 'opt_value': 'pxelinux.0', 'ip_version': 4}, {'opt_name': '66', 'opt_value': '', 'ip_version': 4}] :param token: An optional authentication token. Deprecated, use context :param context: request context :type context: ironic.common.context.RequestContext :raises: FailedToUpdateDHCPOptOnPort """ # TODO(pas-ha) ignore token arg in Rocky if token: LOG.warning("Using the 'token' argument is deprecated, " "use the 'context' argument to pass the " "full request context instead.")
[docs] @abc.abstractmethod def update_dhcp_opts(self, task, options, vifs=None): """Send or update the DHCP BOOT options for this node. :param task: A TaskManager instance. :param options: this will be a list of dicts, e.g. :: [{'opt_name': '67', 'opt_value': 'pxelinux.0', 'ip_version': 4}, {'opt_name': '66', 'opt_value': '', 'ip_version': 4}] :param vifs: A dict with keys 'ports' and 'portgroups' and dicts as values. Each dict has key/value pairs of the form <ironic UUID>:<neutron port UUID>. e.g. :: {'ports': {'port.uuid':}, 'portgroups': {'portgroup.uuid':}} If the value is None, will get the list of ports/portgroups from the Ironic port/portgroup objects. :raises: FailedToUpdateDHCPOptOnPort """
[docs] def get_ip_addresses(self, task): """Get IP addresses for all ports/portgroups in `task`. :param task: A TaskManager instance. :returns: List of IP addresses associated with task's ports and portgroups. """ return []
[docs] def clean_dhcp_opts(self, task): """Clean up the DHCP BOOT options for all ports in `task`. :param task: A TaskManager instance. :raises: FailedToCleanDHCPOpts """ pass
[docs] def supports_ipxe_tag(self): """Whether the provider will correctly apply the 'ipxe' tag. When iPXE makes a DHCP request, does this provider support adding the tag `ipxe` or `ipxe6` (for IPv6). When the provider returns True, options can be added which filter on these tags. :returns: True when the driver supports tagging iPXE DHCP requests """ return False