Source code for

# Copyright 2014 Rackspace, Inc.
#    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.

from oslo_log import log

from ironic.common import exception

LOG = log.getLogger(__name__)

[docs]def get_node_vif_ids(task): """Get all VIF ids for a node. This function does not handle multi node operations. :param task: a TaskManager instance. :returns: A dict of Node's neutron ports where keys are 'ports' & 'portgroups' and the values are dict of UUIDs and their associated VIFs, e.g. :: {'ports': {'port.uuid':}, 'portgroups': {'portgroup.uuid':}} """ vifs = {} portgroup_vifs = {} port_vifs = {} for portgroup in task.portgroups: vif =, portgroup) if vif: portgroup_vifs[portgroup.uuid] = vif vifs['portgroups'] = portgroup_vifs for port in task.ports: vif =, port) if vif: port_vifs[port.uuid] = vif vifs['ports'] = port_vifs return vifs
[docs]def get_portgroup_by_id(task, portgroup_id): """Lookup a portgroup by ID on a task object. :param task: a TaskManager instance :param portgroup_id: ID of the portgroup. :returns: A Portgroup object or None. """ for portgroup in task.portgroups: if == portgroup_id: return portgroup
[docs]def get_ports_by_portgroup_id(task, portgroup_id): """Lookup ports by their portgroup ID on a task object. :param task: a TaskManager instance :param portgroup_id: ID of the portgroup. :returns: A list of Port objects. """ return [port for port in task.ports if port.portgroup_id == portgroup_id]
[docs]def get_physnets_for_node(task): """Return the set of physical networks for a node. Returns the set of physical networks associated with a node's ports. The physical network None is excluded from the set. :param task: a TaskManager instance :returns: A set of physical networks. """ return set(port.physical_network for port in task.ports if port.physical_network is not None)
[docs]def get_physnets_by_portgroup_id(task, portgroup_id, exclude_port=None): """Return the set of physical networks associated with a portgroup. :param task: a TaskManager instance. :param portgroup_id: ID of the portgroup. :param exclude_port: A Port object to exclude from the determination of the portgroup's physical network, or None. :returns: The set of physical networks associated with the portgroup. The set will contain zero or one physical networks. :raises: PortgroupPhysnetInconsistent if the portgroup's ports are not assigned the same physical network. """ pg_ports = get_ports_by_portgroup_id(task, portgroup_id) if exclude_port is not None and 'id' in exclude_port: exclude_port_id = else: exclude_port_id = None pg_physnets = set(port.physical_network for port in pg_ports if != exclude_port_id) # Sanity check: all ports should have the same physical network. if len(pg_physnets) > 1: portgroup = get_portgroup_by_id(task, portgroup_id) raise exception.PortgroupPhysnetInconsistent( portgroup=portgroup.uuid, physical_networks=", ".join(pg_physnets)) return pg_physnets
[docs]def remove_vifs_from_node(task): """Remove all vif attachment records from a node. :param task: a TaskManager instance. """ vifs = for vif_entry in vifs: vif = vif_entry.get('id') if not vif: LOG.warning('Node %(node)s has an incorrect VIF entry: %(found)s. ' 'This entry lacks an "id" field and is thus ' 'unsupported.', {'node': task.node.uuid, 'found': vif_entry}) continue try:, vif) except exception.VifNotAttached: LOG.warning('While removing records of VIF attachments from node ' '%(node)s, we received indication that VIF %(vif)s is ' 'no longer attached. This should not happen under ' 'normal circumstances.', {'node': task.node.uuid, 'vif': vif}) except exception.NetworkError as e: LOG.error('For node %(node)s, an error occurred while removing a ' 'VIF record for VIF %(vif)s. Error: %(error)s', {'node': task.node.uuid, 'vif': vif, 'error': e})