/components/openstack/nova/files/solariszones/driver.py

# Copyright 2011 Justin Santa Barbara
# All Rights Reserved.
#
# Copyright (c) 2013, 2016, Oracle and/or its affiliates. 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
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
#    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.

"""
Driver for Solaris Zones (nee Containers):
"""

import base64
import glob
import os
import platform
import shutil
import tempfile
import uuid

from collections import defaultdict
from openstack_common import get_ovsdb_info
import rad.bindings.com.oracle.solaris.rad.archivemgr_1 as archivemgr
import rad.bindings.com.oracle.solaris.rad.kstat_2 as kstat
import rad.bindings.com.oracle.solaris.rad.zonemgr_1 as zonemgr
import rad.client
import rad.connect
from solaris_install.target.size import Size

from cinderclient import exceptions as cinder_exception
from cinderclient.v1 import client as v1_client
from eventlet import greenthread
from keystoneclient import exceptions as keystone_exception
from lxml import etree
from oslo_concurrency import lockutils, processutils
from oslo_config import cfg
from oslo_log import log as logging
from oslo_serialization import jsonutils
from oslo_utils import excutils
from oslo_utils import fileutils
from oslo_utils import strutils
from oslo_utils import versionutils
from passlib.hash import sha256_crypt

from nova.api.metadata import password
from nova.compute import arch
from nova.compute import hv_type
from nova.compute import power_state
from nova.compute import task_states
from nova.compute import vm_mode
from nova.compute import vm_states
from nova import conductor
import nova.conf
from nova.console import type as ctype
from nova import context as nova_context
from nova import crypto
from nova import exception
from nova.i18n import _, _LE, _LI
from nova.image import API as glance_api
from nova.image import glance
from nova.network.neutronv2 import api as neutronv2_api
from nova import objects
from nova.objects import flavor as flavor_obj
from nova.objects import migrate_data as migrate_data_obj
from nova import utils
from nova.virt import driver
from nova.virt import event as virtevent
from nova.virt import hardware
from nova.virt import images
from nova.virt.solariszones import sysconfig
from nova.volume.cinder import API
from nova.volume.cinder import cinderclient
from nova.volume.cinder import translate_volume_exception
from nova.volume.cinder import _untranslate_volume_summary_view

solariszones_opts = [
    cfg.StrOpt('boot_volume_type',
               default=None,
               help='Cinder volume type to use for boot volumes'),
    cfg.StrOpt('boot_volume_az',
               default=None,
               help='Cinder availability zone to use for boot volumes'),
    cfg.StrOpt('glancecache_dirname',
               default='/var/share/nova/images',
               help='Default path to Glance cache for Solaris Zones.'),
    cfg.StrOpt('live_migration_cipher',
               help='Cipher to use for encryption of memory traffic during '
                    'live migration. If not specified, a common encryption '
                    'algorithm will be negotiated. Options include: none or '
                    'the name of a supported OpenSSL cipher algorithm.'),
    cfg.StrOpt('solariszones_snapshots_directory',
               default='$instances_path/snapshots',
               help='Location to store snapshots before uploading them to the '
                    'Glance image service.'),
    cfg.StrOpt('zones_suspend_path',
               default='/var/share/zones/SYSsuspend',
               help='Default path for suspend images for Solaris Zones.'),
    cfg.BoolOpt('solariszones_boot_options',
                default=True,
                help='Allow kernel boot options to be set in instance '
                     'metadata.'),
]

CONF = nova.conf.CONF
CONF.register_opts(solariszones_opts, 'solariszones')
LOG = logging.getLogger(__name__)

# These should match the strings returned by the zone_state_str()
# function in the (private) libzonecfg library. These values are in turn
# returned in the 'state' string of the Solaris Zones' RAD interface by
# the zonemgr(3RAD) provider.
ZONE_STATE_CONFIGURED = 'configured'
ZONE_STATE_INCOMPLETE = 'incomplete'
ZONE_STATE_UNAVAILABLE = 'unavailable'
ZONE_STATE_INSTALLED = 'installed'
ZONE_STATE_READY = 'ready'
ZONE_STATE_RUNNING = 'running'
ZONE_STATE_SHUTTING_DOWN = 'shutting_down'
ZONE_STATE_DOWN = 'down'
ZONE_STATE_MOUNTED = 'mounted'

# Mapping between zone state and Nova power_state.
SOLARISZONES_POWER_STATE = {
    ZONE_STATE_CONFIGURED:      power_state.NOSTATE,
    ZONE_STATE_INCOMPLETE:      power_state.NOSTATE,
    ZONE_STATE_UNAVAILABLE:     power_state.NOSTATE,
    ZONE_STATE_INSTALLED:       power_state.SHUTDOWN,
    ZONE_STATE_READY:           power_state.RUNNING,
    ZONE_STATE_RUNNING:         power_state.RUNNING,
    ZONE_STATE_SHUTTING_DOWN:   power_state.RUNNING,
    ZONE_STATE_DOWN:            power_state.RUNNING,
    ZONE_STATE_MOUNTED:         power_state.NOSTATE
}

# Solaris Zones brands as defined in brands(5).
ZONE_BRAND_LABELED = 'labeled'
ZONE_BRAND_SOLARIS = 'solaris'
ZONE_BRAND_SOLARIS_KZ = 'solaris-kz'
ZONE_BRAND_SOLARIS10 = 'solaris10'

# Mapping between supported zone brands and the name of the corresponding
# brand template.
ZONE_BRAND_TEMPLATE = {
    ZONE_BRAND_SOLARIS:         'SYSdefault',
    ZONE_BRAND_SOLARIS_KZ:      'SYSsolaris-kz',
}

MAX_CONSOLE_BYTES = 102400

VNC_CONSOLE_BASE_FMRI = 'svc:/application/openstack/nova/zone-vnc-console'
# Required in order to create a zone VNC console SMF service instance
VNC_SERVER_PATH = '/usr/bin/vncserver'
XTERM_PATH = '/usr/bin/xterm'

ROOTZPOOL_RESOURCE = 'rootzpool'

# The underlying Solaris Zones framework does not expose a specific
# version number, instead relying on feature tests to identify what is
# and what is not supported. A HYPERVISOR_VERSION is defined here for
# Nova's use but it generally should not be changed unless there is a
# incompatible change such as concerning kernel zone live migration.
HYPERVISOR_VERSION = '5.11'

shared_storage = ['iscsi', 'fibre_channel']

KSTAT_TYPE = {
    'NVVT_STR': 'string',
    'NVVT_STRS': 'strings',
    'NVVT_INT': 'integer',
    'NVVT_INTS': 'integers',
    'NVVT_KSTAT': 'kstat',
}


def lookup_resource(zone, resource):
    """Lookup specified resource from specified Solaris Zone."""
    try:
        val = zone.getResources(zonemgr.Resource(resource))
    except rad.client.ObjectError:
        return None
    except Exception:
        raise
    return val[0] if val else None


def lookup_resource_property(zone, resource, prop, filter=None):
    """Lookup specified property from specified Solaris Zone resource."""
    try:
        val = zone.getResourceProperties(zonemgr.Resource(resource, filter),
                                         [prop])
    except rad.client.ObjectError:
        return None
    except Exception:
        raise
    return val[0].value if val else None


def lookup_resource_property_value(zone, resource, prop, value):
    """Lookup specified property with value from specified Solaris Zone
    resource. Returns resource object if matching value is found, else None
    """
    try:
        resources = zone.getResources(zonemgr.Resource(resource))
        for resource in resources:
            for propertee in resource.properties:
                if propertee.name == prop and propertee.value == value:
                    return resource
        else:
            return None
    except rad.client.ObjectError:
        return None
    except Exception:
        raise


def zonemgr_strerror(ex):
    """Format the payload from a zonemgr(3RAD) rad.client.ObjectError
    exception into a sensible error string that can be logged. Newlines
    are converted to a colon-space string to create a single line.

    If the exception was something other than rad.client.ObjectError,
    just return it as a string.
    """
    if not isinstance(ex, rad.client.ObjectError):
        return str(ex)
    payload = ex.get_payload()
    if payload.code == zonemgr.ErrorCode.NONE:
        return str(ex)
    error = [str(payload.code)]
    if payload.str is not None and payload.str != '':
        error.append(payload.str)
    if payload.stderr is not None and payload.stderr != '':
        stderr = payload.stderr.rstrip()
        error.append(stderr.replace('\n', ': '))
    result = ': '.join(error)
    return result


class MemoryAlignmentIncorrect(exception.FlavorMemoryTooSmall):
    msg_fmt = _("Requested flavor, %(flavor)s, memory size %(memsize)s does "
                "not align on %(align)s boundary.")


class SolarisVolumeAPI(API):
    """ Extending the volume api to support additional cinder sub-commands
    """
    @translate_volume_exception
    def create(self, context, size, name, description, snapshot=None,
               image_id=None, volume_type=None, metadata=None,
               availability_zone=None, source_volume=None):
        """Clone the source volume by calling the cinderclient version of
        create with a source_volid argument

        :param context: the context for the clone
        :param size: size of the new volume, must be the same as the source
            volume
        :param name: display_name of the new volume
        :param description: display_description of the new volume
        :param snapshot: Snapshot object
        :param image_id: image_id to create the volume from
        :param volume_type: type of volume
        :param metadata: Additional metadata for the volume
        :param availability_zone: zone:host where the volume is to be created
        :param source_volume: Volume object

        Returns a volume object
        """
        client = cinderclient(context)

        if snapshot is not None:
            snapshot_id = snapshot['id']
        else:
            snapshot_id = None

        if source_volume is not None:
            source_volid = source_volume['id']
        else:
            source_volid = None

        kwargs = dict(snapshot_id=snapshot_id,
                      volume_type=volume_type,
                      user_id=context.user_id,
                      project_id=context.project_id,
                      availability_zone=availability_zone,
                      metadata=metadata,
                      imageRef=image_id,
                      source_volid=source_volid)

        if isinstance(client, v1_client.Client):
            kwargs['display_name'] = name
            kwargs['display_description'] = description
        else:
            kwargs['name'] = name
            kwargs['description'] = description

        try:
            item = cinderclient(context).volumes.create(size, **kwargs)
            return _untranslate_volume_summary_view(context, item)
        except cinder_exception.OverLimit:
            raise exception.OverQuota(overs='volumes')
        except (cinder_exception.BadRequest,
                keystone_exception.BadRequest) as reason:
            raise exception.InvalidInput(reason=reason)

    @translate_volume_exception
    def update(self, context, volume_id, fields):
        """Update the fields of a volume for example used to rename a volume
        via a call to cinderclient

        :param context: the context for the update
        :param volume_id: the id of the volume to update
        :param fields: a dictionary of of the name/value pairs to update
        """
        cinderclient(context).volumes.update(volume_id, **fields)

    @translate_volume_exception
    def extend(self, context, volume, newsize):
        """Extend the size of a cinder volume by calling the cinderclient

        :param context: the context for the extend
        :param volume: the volume object to extend
        :param newsize: the new size of the volume in GB
        """
        cinderclient(context).volumes.extend(volume, newsize)


class ZoneConfig(object):
    """ZoneConfig - context manager for access zone configurations.
    Automatically opens the configuration for a zone and commits any changes
    before exiting
    """
    def __init__(self, zone):
        """zone is a zonemgr object representing either a kernel zone or
        non-global zone.
        """
        self.zone = zone
        self.editing = False

    def __enter__(self):
        """enables the editing of the zone."""
        try:
            self.zone.editConfig()
            self.editing = True
            return self
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to initialize editing of instance '%s' "
                            "via zonemgr(3RAD): %s")
                          % (self.zone.name, reason))
            raise

    def __exit__(self, exc_type, exc_val, exc_tb):
        """looks for any kind of exception before exiting.  If one is found,
        cancel any configuration changes and reraise the exception.  If not,
        commit the new configuration.
        """
        if exc_type is not None and self.editing:
            # We received some kind of exception.  Cancel the config and raise.
            self.zone.cancelConfig()
            raise
        else:
            # commit the config
            try:
                self.zone.commitConfig()
            except Exception as ex:
                reason = zonemgr_strerror(ex)
                LOG.exception(_("Unable to commit the new configuration for "
                                "instance '%s' via zonemgr(3RAD): %s")
                              % (self.zone.name, reason))

                # Last ditch effort to cleanup.
                self.zone.cancelConfig()
                raise

    def setprop(self, resource, prop, value):
        """sets a property for an existing resource OR creates a new resource
        with the given property(s).
        """
        current = lookup_resource_property(self.zone, resource, prop)
        if current is not None and current == value:
            # the value is already set
            return

        try:
            if current is None:
                self.zone.addResource(zonemgr.Resource(
                    resource, [zonemgr.Property(prop, value)]))
            else:
                self.zone.setResourceProperties(
                    zonemgr.Resource(resource),
                    [zonemgr.Property(prop, value)])
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to set '%s' property on '%s' resource for "
                            "instance '%s' via zonemgr(3RAD): %s")
                          % (prop, resource, self.zone.name, reason))
            raise

    def addresource(self, resource, props=None, ignore_exists=False):
        """creates a new resource with an optional property list, or set the
        property if the resource exists and ignore_exists is true.

        :param ignore_exists: If the resource exists, set the property for the
            resource.
        """
        if props is None:
            props = []

        try:
            self.zone.addResource(zonemgr.Resource(resource, props))
        except Exception as ex:
            if isinstance(ex, rad.client.ObjectError):
                code = ex.get_payload().code
                if (ignore_exists and
                        code == zonemgr.ErrorCode.RESOURCE_ALREADY_EXISTS):
                    self.zone.setResourceProperties(
                        zonemgr.Resource(resource, None), props)
                    return
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to create new resource '%s' for instance "
                            "'%s' via zonemgr(3RAD): %s")
                          % (resource, self.zone.name, reason))
            raise

    def removeresources(self, resource, props=None):
        """removes resources whose properties include the optional property
        list specified in props.
        """
        if props is None:
            props = []

        try:
            self.zone.removeResources(zonemgr.Resource(resource, props))
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to remove resource '%s' for instance '%s' "
                            "via zonemgr(3RAD): %s")
                          % (resource, self.zone.name, reason))
            raise

    def clear_resource_props(self, resource, props):
        """Clear property values of a given resource
        """
        try:
            self.zone.clearResourceProperties(zonemgr.Resource(resource, None),
                                              props)
        except rad.client.ObjectError as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to clear '%s' property on '%s' resource "
                            "for instance '%s' via zonemgr(3RAD): %s")
                          % (props, resource, self.zone.name, reason))
            raise


class SolarisZonesDriver(driver.ComputeDriver):
    """Solaris Zones Driver using the zonemgr(3RAD) and kstat(3RAD) providers.

    The interface to this class talks in terms of 'instances' (Amazon EC2 and
    internal Nova terminology), by which we mean 'running virtual machine'
    (XenAPI terminology) or domain (Xen or libvirt terminology).

    An instance has an ID, which is the identifier chosen by Nova to represent
    the instance further up the stack.  This is unfortunately also called a
    'name' elsewhere.  As far as this layer is concerned, 'instance ID' and
    'instance name' are synonyms.

    Note that the instance ID or name is not human-readable or
    customer-controlled -- it's an internal ID chosen by Nova.  At the
    nova.virt layer, instances do not have human-readable names at all -- such
    things are only known higher up the stack.

    Most virtualization platforms will also have their own identity schemes,
    to uniquely identify a VM or domain.  These IDs must stay internal to the
    platform-specific layer, and never escape the connection interface.  The
    platform-specific layer is responsible for keeping track of which instance
    ID maps to which platform-specific ID, and vice versa.

    Some methods here take an instance of nova.compute.service.Instance.  This
    is the data structure used by nova.compute to store details regarding an
    instance, and pass them into this layer.  This layer is responsible for
    translating that generic data structure into terms that are specific to the
    virtualization platform.

    """

    capabilities = {
        "has_imagecache": False,
        "supports_recreate": True,
        "supports_migrate_to_same_host": False
    }

    def __init__(self, virtapi):
        self.virtapi = virtapi
        self._archive_manager = None
        self._compute_event_callback = None
        self._conductor_api = conductor.API()
        self._fc_hbas = None
        self._fc_wwnns = None
        self._fc_wwpns = None
        self._host_stats = {}
        self._initiator = None
        self._install_engine = None
        self._kstat_control = None
        self._pagesize = os.sysconf('SC_PAGESIZE')
        self._rad_connection = None
        self._rootzpool_suffix = ROOTZPOOL_RESOURCE
        self._uname = os.uname()
        self._validated_archives = list()
        self._volume_api = SolarisVolumeAPI()
        self._zone_manager = None

    @property
    def rad_connection(self):
        if self._rad_connection is None:
            self._rad_connection = rad.connect.connect_unix()
        else:
            # taken from rad.connect.RadConnection.__repr__ to look for a
            # closed connection
            if self._rad_connection._closed is not None:
                # the RAD connection has been lost.  Reconnect to RAD
                self._rad_connection = rad.connect.connect_unix()

        return self._rad_connection

    @property
    def zone_manager(self):
        try:
            if (self._zone_manager is None or
                    self._zone_manager._conn._closed is not None):
                self._zone_manager = self.rad_connection.get_object(
                    zonemgr.ZoneManager())
        except Exception as ex:
            reason = _("Unable to obtain RAD object: %s") % ex
            raise exception.NovaException(reason)

        return self._zone_manager

    @property
    def kstat_control(self):
        try:
            if (self._kstat_control is None or
                    self._kstat_control._conn._closed is not None):
                self._kstat_control = self.rad_connection.get_object(
                    kstat.Control())
        except Exception as ex:
            reason = _("Unable to obtain RAD object: %s") % ex
            raise exception.NovaException(reason)

        return self._kstat_control

    @property
    def archive_manager(self):
        try:
            if (self._archive_manager is None or
                    self._archive_manager._conn._closed is not None):
                self._archive_manager = self.rad_connection.get_object(
                    archivemgr.ArchiveManager())
        except Exception as ex:
            reason = _("Unable to obtain RAD object: %s") % ex
            raise exception.NovaException(reason)

        return self._archive_manager

    def init_host(self, host):
        """Initialize anything that is necessary for the driver to function,
        including catching up with currently running VM's on the given host.
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        pass

    def cleanup_host(self, host):
        """Clean up anything that is necessary for the driver gracefully stop,
        including ending remote sessions. This is optional.
        """
        pass

    def _get_fc_hbas(self):
        """Get Fibre Channel HBA information."""
        if self._fc_hbas:
            return self._fc_hbas

        out = None
        try:
            out, err = utils.execute('/usr/sbin/fcinfo', 'hba-port')
        except processutils.ProcessExecutionError:
            return []

        if out is None:
            raise RuntimeError(_("Cannot find any Fibre Channel HBAs"))

        hbas = []
        hba = {}
        for line in out.splitlines():
            line = line.strip()
            # Collect the following hba-port data:
            # 1: Port WWN
            # 2: State (online|offline)
            # 3: Node WWN
            if line.startswith("HBA Port WWN:"):
                # New HBA port entry
                hba = {}
                wwpn = line.split()[-1]
                hba['port_name'] = wwpn
                continue
            elif line.startswith("Port Mode:"):
                mode = line.split()[-1]
                # Skip Target mode ports
                if mode != 'Initiator':
                    break
            elif line.startswith("State:"):
                state = line.split()[-1]
                hba['port_state'] = state
                continue
            elif line.startswith("Node WWN:"):
                wwnn = line.split()[-1]
                hba['node_name'] = wwnn
                continue
            if len(hba) == 3:
                hbas.append(hba)
                hba = {}
        self._fc_hbas = hbas
        return self._fc_hbas

    def _get_fc_wwnns(self):
        """Get Fibre Channel WWNNs from the system, if any."""
        hbas = self._get_fc_hbas()

        wwnns = []
        for hba in hbas:
            if hba['port_state'] == 'online':
                wwnn = hba['node_name']
                wwnns.append(wwnn)
        return wwnns

    def _get_fc_wwpns(self):
        """Get Fibre Channel WWPNs from the system, if any."""
        hbas = self._get_fc_hbas()

        wwpns = []
        for hba in hbas:
            if hba['port_state'] == 'online':
                wwpn = hba['port_name']
                wwpns.append(wwpn)
        return wwpns

    def _get_iscsi_initiator(self):
        """ Return the iSCSI initiator node name IQN for this host """
        try:
            out, err = utils.execute('/usr/sbin/iscsiadm', 'list',
                                     'initiator-node')
            # Sample first line of command output:
            # Initiator node name: iqn.1986-03.com.sun:01:e00000000000.4f757217
            initiator_name_line = out.splitlines()[0]
            initiator_iqn = initiator_name_line.rsplit(' ', 1)[1]
            return initiator_iqn
        except processutils.ProcessExecutionError as ex:
            LOG.info(_("Failed to get the initiator-node info: %s") % (ex))
            return None

    def _get_zone_by_name(self, name):
        """Return a Solaris Zones object via RAD by name."""
        try:
            zone = self.rad_connection.get_object(
                zonemgr.Zone(), rad.client.ADRGlobPattern({'name': name}))
        except rad.client.NotFoundError:
            return None
        except Exception:
            raise
        return zone

    def _get_state(self, zone):
        """Return the running state, one of the power_state codes."""
        return SOLARISZONES_POWER_STATE[zone.state]

    def _pages_to_kb(self, pages):
        """Convert a number of pages of memory into a total size in KBytes."""
        return (pages * self._pagesize) / 1024

    def _get_max_mem(self, zone):
        """Return the maximum memory in KBytes allowed."""
        if zone.brand == ZONE_BRAND_SOLARIS:
            mem_resource = 'swap'
        else:
            mem_resource = 'physical'

        max_mem = lookup_resource_property(zone, 'capped-memory', mem_resource)
        if max_mem is not None:
            return strutils.string_to_bytes("%sB" % max_mem) / 1024

        # If physical property in capped-memory doesn't exist, this may
        # represent a non-global zone so just return the system's total
        # memory.
        return self._pages_to_kb(os.sysconf('SC_PHYS_PAGES'))

    def _get_mem(self, zone):
        """Return the memory in KBytes used by the domain."""

        # There isn't any way of determining this from the hypervisor
        # perspective in Solaris, so just return the _get_max_mem() value
        # for now.
        return self._get_max_mem(zone)

    def _get_num_cpu(self, zone):
        """Return the number of virtual CPUs for the domain.

        In the case of kernel zones, the number of virtual CPUs a zone
        ends up with depends on whether or not there were 'virtual-cpu'
        or 'dedicated-cpu' resources in the configuration or whether
        there was an assigned pool in the configuration. This algorithm
        attempts to emulate what the virtual platform code does to
        determine a number of virtual CPUs to use.
        """
        # If a 'virtual-cpu' resource exists, use the minimum number of
        # CPUs defined there.
        ncpus = lookup_resource_property(zone, 'virtual-cpu', 'ncpus')
        if ncpus is not None:
            min = ncpus.split('-', 1)[0]
            if min.isdigit():
                return int(min)

        # Otherwise if a 'dedicated-cpu' resource exists, use the maximum
        # number of CPUs defined there.
        ncpus = lookup_resource_property(zone, 'dedicated-cpu', 'ncpus')
        if ncpus is not None:
            max = ncpus.split('-', 1)[-1]
            if max.isdigit():
                return int(max)

        # Finally if neither resource exists but the zone was assigned a
        # pool in the configuration, the number of CPUs would be the size
        # of the processor set. Currently there's no way of easily
        # determining this so use the system's notion of the total number
        # of online CPUs.
        return os.sysconf('SC_NPROCESSORS_ONLN')

    def _kstat_data(self, uri):
        """Return Kstat snapshot data via RAD as a dictionary."""
        if not isinstance(uri, str):
            raise exception.NovaException("kstat URI must be string type: "
                                          "%s is %s" % (uri, type(uri)))

        if not uri.startswith("kstat:/"):
            uri = "kstat:/" + uri

        try:
            self.kstat_control.update()
            kstat_obj = self.rad_connection.get_object(
                kstat.Kstat(), rad.client.ADRGlobPattern({"uri": uri}))

        except Exception as reason:
            LOG.info(_("Unable to retrieve kstat object '%s' via kstat(3RAD): "
                       "%s") % (uri, reason))
            return None

        ks_data = {}
        for name, data in kstat_obj.getMap().items():
            ks_data[name] = getattr(data, KSTAT_TYPE[str(data.type)])

        return ks_data

    def _sum_kstat_statistic(self, kstat_data, statistic):
        total = 0
        for ks in kstat_data.values():
            data = ks.getMap()[statistic]
            value = getattr(data, KSTAT_TYPE[str(data.type)])
            try:
                total += value
            except TypeError:
                LOG.error(_("Unable to aggregate non-summable kstat %s;%s "
                            " of type %s") % (ks.getParent().uri, statistic,
                                              type(value)))
                return None

        return total

    def _get_kstat_statistic(self, ks, statistic):
        if not isinstance(ks, kstat.Kstat):
            reason = (_("Attempted to get a kstat from %s type.") % (type(ks)))
            raise TypeError(reason)

        try:
            data = ks.getMap()[statistic]
            value = getattr(data, KSTAT_TYPE[str(data.type)])
        except TypeError:
            value = None

        return value

    def _get_cpu_time(self, zone):
        """Return the CPU time used in nanoseconds."""
        if zone.id == -1:
            return 0

        # The retry value of 3 was determined by the "we shouldn't hit this
        # often, but if we do it should resolve quickly so try again"+1
        # algorithm.
        for _attempt in range(3):
            total = 0

            accum_uri = "kstat:/zones/cpu/sys_zone_accum/%d" % zone.id
            uri = "kstat:/zones/cpu/sys_zone_%d" % zone.id

            initial = self._kstat_data(accum_uri)
            cpus = self._kstat_data(uri)

            total += self._sum_kstat_statistic(cpus, 'cpu_nsec_kernel_cur')
            total += self._sum_kstat_statistic(cpus, 'cpu_nsec_user_cur')

            final = self._kstat_data(accum_uri)

            if initial['gen_num'] == final['gen_num']:
                total += initial['cpu_nsec_user'] + initial['cpu_nsec_kernel']
                return total

        LOG.error(_("Unable to get accurate cpu usage beacuse cpu list "
                    "keeps changing"))
        return 0

    def get_info(self, instance):
        """Get the current status of an instance, by name (not ID!)

        :param instance: nova.objects.instance.Instance object

        Returns a InstanceInfo object
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)
        return hardware.InstanceInfo(state=self._get_state(zone),
                                     max_mem_kb=self._get_max_mem(zone),
                                     mem_kb=self._get_mem(zone),
                                     num_cpu=self._get_num_cpu(zone),
                                     cpu_time_ns=self._get_cpu_time(zone))

    def get_num_instances(self):
        """Return the total number of virtual machines.

        Return the number of virtual machines that the hypervisor knows
        about.

        .. note::

            This implementation works for all drivers, but it is
            not particularly efficient. Maintainers of the virt drivers are
            encouraged to override this method with something more
            efficient.
        """
        return len(self.list_instances())

    def instance_exists(self, instance):
        """Checks existence of an instance on the host.

        :param instance: The instance to lookup

        Returns True if an instance with the supplied ID exists on
        the host, False otherwise.

        .. note::

            This implementation works for all drivers, but it is
            not particularly efficient. Maintainers of the virt drivers are
            encouraged to override this method with something more
            efficient.
        """
        try:
            return instance.uuid in self.list_instance_uuids()
        except NotImplementedError:
            return instance.name in self.list_instances()

    def estimate_instance_overhead(self, instance_info):
        """Estimate the virtualization overhead required to build an instance
        of the given flavor.

        Defaults to zero, drivers should override if per-instance overhead
        calculations are desired.

        :param instance_info: Instance/flavor to calculate overhead for.
        :returns: Dict of estimated overhead values.
        """
        return {'memory_mb': 0}

    def _get_list_zone_object(self):
        """Return a list of all Solaris Zones objects via RAD."""
        return self.rad_connection.list_objects(zonemgr.Zone())

    def list_instances(self):
        """Return the names of all the instances known to the virtualization
        layer, as a list.
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        instances_list = []
        for zone in self._get_list_zone_object():
            instances_list.append(self.rad_connection.get_object(zone).name)
        return instances_list

    def list_instance_uuids(self):
        """Return the UUIDS of all the instances known to the virtualization
        layer, as a list.
        """
        raise NotImplementedError()

    def _rebuild_block_devices(self, context, instance, bdms, recreate):
        root_ci = None
        rootmp = instance['root_device_name']
        for entry in bdms:
            if entry['connection_info'] is None:
                continue

            if entry['device_name'] == rootmp:
                root_ci = jsonutils.loads(entry['connection_info'])
                # Let's make sure this is a well formed connection_info, by
                # checking if it has a serial key that represents the
                # volume_id. If not check to see if the block device has a
                # volume_id, if so then assign this to the root_ci.serial.
                #
                # If we cannot repair the connection_info then simply do not
                # return a root_ci and let the caller decide if they want to
                # fail or not.
                if root_ci.get('serial') is None:
                    if entry.get('volume_id') is not None:
                        root_ci['serial'] = entry['volume_id']
                    else:
                        LOG.debug(_("Unable to determine the volume id for "
                                    "the connection info for the root device "
                                    "for instance '%s'") % instance['name'])
                        root_ci = None

                continue

            if not recreate:
                ci = jsonutils.loads(entry['connection_info'])
                self.detach_volume(ci, instance, entry['device_name'])

        if root_ci is None and recreate:
            msg = (_("Unable to find the root device for instance '%s'.")
                   % instance['name'])
            raise exception.NovaException(msg)

        return root_ci

    def _set_instance_metahostid(self, instance):
        """Attempt to get the hostid from the current configured zone and
        return the hostid.  Otherwise return None, and do not set the hostid in
        the instance
        """
        hostid = instance.system_metadata.get('hostid')
        if hostid is not None:
            return hostid

        zone = self._get_zone_by_name(instance['name'])
        if zone is None:
            return None

        hostid = lookup_resource_property(zone, 'global', 'hostid')
        if hostid:
            instance.system_metadata['hostid'] = hostid

        return hostid

    def rebuild(self, context, instance, image_meta, injected_files,
                admin_password, bdms, detach_block_devices,
                attach_block_devices, network_info=None,
                recreate=False, block_device_info=None,
                preserve_ephemeral=False):
        """Destroy and re-make this instance.

        A 'rebuild' effectively purges all existing data from the system and
        remakes the VM with given 'metadata' and 'personalities'.

        This base class method shuts down the VM, detaches all block devices,
        then spins up the new VM afterwards. It may be overridden by
        hypervisors that need to - e.g. for optimisations, or when the 'VM'
        is actually proxied and needs to be held across the shutdown + spin
        up steps.

        :param context: security context
        :param instance: nova.objects.instance.Instance
                         This function should use the data there to guide
                         the creation of the new instance.
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        :param injected_files: User files to inject into instance.
        :param admin_password: Administrator password to set in instance.
        :param bdms: block-device-mappings to use for rebuild
        :param detach_block_devices: function to detach block devices. See
            nova.compute.manager.ComputeManager:_rebuild_default_impl for
            usage.
        :param attach_block_devices: function to attach block devices. See
            nova.compute.manager.ComputeManager:_rebuild_default_impl for
            usage.
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param recreate: True if the instance is being recreated on a new
            hypervisor - all the cleanup of old state is skipped.
        :param block_device_info: Information about block devices to be
                                  attached to the instance.
        :param preserve_ephemeral: True if the default ephemeral storage
                                   partition must be preserved on rebuild
        """
        if recreate:
            instance.system_metadata['evac_from'] = instance['launched_on']
            instance.save()
            extra_specs = self._get_flavor(instance)['extra_specs'].copy()
            brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
            if brand == ZONE_BRAND_SOLARIS:
                msg = (_("'%s' branded zones do not currently support "
                         "evacuation.") % brand)
                raise exception.NovaException(msg)
        else:
            self._power_off(instance, "HALT")

        instance.task_state = task_states.REBUILD_BLOCK_DEVICE_MAPPING
        instance.save(expected_task_state=[task_states.REBUILDING])
        root_ci = self._rebuild_block_devices(context, instance, bdms,
                                              recreate)

        if recreate:
            if root_ci is not None:
                driver_type = root_ci['driver_volume_type']
            else:
                driver_type = 'local'
            if driver_type not in shared_storage:
                msg = (_("Root device is not on shared storage for instance "
                         "'%s'.") % instance['name'])
                raise exception.NovaException(msg)

        if not recreate:
            self.destroy(context, instance, network_info, block_device_info)
            if root_ci is not None:
                self._volume_api.detach(context, root_ci['serial'])
                self._volume_api.delete(context, root_ci['serial'])

                # Go ahead and remove the root bdm from the bdms so that we do
                # not trip up spawn either checking against the use of c1d0 or
                # attempting to re-attach the root device.
                bdms.objects.remove(bdms.root_bdm())
                rootdevname = block_device_info.get('root_device_name')
                if rootdevname is not None:
                    bdi_bdms = block_device_info.get('block_device_mapping')
                    for entry in bdi_bdms:
                        if entry['mount_device'] == rootdevname:
                            bdi_bdms.remove(entry)
                            break

        instance.task_state = task_states.REBUILD_SPAWNING
        instance.save(
            expected_task_state=[task_states.REBUILD_BLOCK_DEVICE_MAPPING])

        # Instead of using a boolean for 'rebuilding' scratch data, use a
        # string because the object will translate it to a string anyways.
        if recreate:
            extra_specs = self._get_flavor(instance)['extra_specs'].copy()

            instance.system_metadata['rebuilding'] = 'false'
            self._create_config(context, instance, network_info, root_ci, None)
            del instance.system_metadata['evac_from']
            instance.save()
        else:
            instance.system_metadata['rebuilding'] = 'true'
            self.spawn(context, instance, image_meta, injected_files,
                       admin_password, network_info, block_device_info)

        del instance.system_metadata['rebuilding']
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if recreate:
            zone.attach(['-x', 'initialize-hostdata'])

            rootmp = instance['root_device_name']
            for entry in bdms:
                if (entry['connection_info'] is None or
                        rootmp == entry['device_name']):
                    continue

                connection_info = jsonutils.loads(entry['connection_info'])
                mount = entry['device_name']
                self.attach_volume(context, connection_info, instance, mount)

            self._power_on(instance, network_info)

        if admin_password is not None:
            # Because there is no way to make sure a zone is ready upon
            # returning from a boot request. We must give the zone a few
            # seconds to boot before attempting to set the admin password.
            greenthread.sleep(15)
            self.set_admin_password(instance, admin_password)

    def _get_flavor(self, instance):
        """Retrieve the flavor object as specified in the instance object"""
        return flavor_obj.Flavor.get_by_id(
            nova_context.get_admin_context(read_deleted='yes'),
            instance['instance_type_id'])

    def _fetch_image(self, context, instance):
        """Fetch an image using Glance given the instance's image_ref."""
        glancecache_dirname = CONF.solariszones.glancecache_dirname
        fileutils.ensure_tree(glancecache_dirname)
        iref = instance['image_ref']
        image = os.path.join(glancecache_dirname, iref)
        downloading = image + '.downloading'

        with lockutils.lock('glance-image-%s' % iref):
            if os.path.isfile(downloading):
                LOG.debug(_('Cleaning partial download of %s' % iref))
                os.unlink(image)
                os.unlink(downloading)

            elif os.path.exists(image):
                LOG.debug(_("Using existing, cached Glance image: id %s")
                          % iref)
                return image

            LOG.debug(_("Fetching new Glance image: id %s") % iref)
            try:
                # touch the empty .downloading file
                with open(downloading, 'w'):
                    pass
                images.fetch(context, iref, image, instance['user_id'],
                             instance['project_id'])
                os.unlink(downloading)
                return image
            except Exception as reason:
                LOG.exception(_("Unable to fetch Glance image: id %s: %s")
                              % (iref, reason))
                raise

    @lockutils.synchronized('validate_image')
    def _validate_image(self, context, image, instance):
        """Validate a glance image for compatibility with the instance."""
        # Skip if the image was already checked and confirmed as valid.
        if instance['image_ref'] in self._validated_archives:
            return

        try:
            ua = self.archive_manager.getArchive(image)
        except Exception as ex:
            if isinstance(ex, rad.client.ObjectError):
                reason = ex.get_payload().info
            else:
                reason = str(ex)
            raise exception.ImageUnacceptable(image_id=instance['image_ref'],
                                              reason=reason)

        # Validate the image at this point to ensure:
        # - contains one deployable system
        deployables = ua.getArchivedSystems()
        if len(deployables) != 1:
            reason = _("Image must contain only a single deployable system.")
            raise exception.ImageUnacceptable(image_id=instance['image_ref'],
                                              reason=reason)
        # - matching architecture
        deployable_arch = str(ua.isa)
        compute_arch = platform.processor()
        if deployable_arch.lower() != compute_arch:
            reason = (_("Unified Archive architecture '%s' is incompatible "
                      "with this compute host's architecture, '%s'.")
                      % (deployable_arch, compute_arch))

            # For some reason we have gotten the wrong architecture image,
            # which should have been filtered by the scheduler. One reason this
            # could happen is because the images architecture type is
            # incorrectly set. Check for this and report a better reason.
            glanceapi = glance_api()
            image_meta = glanceapi.get(context, instance['image_ref'])
            image_properties = image_meta.get('properties')
            if image_properties.get('architecture') is None:
                reason = reason + (_(" The 'architecture' property is not set "
                                     "on the Glance image."))

            raise exception.ImageUnacceptable(image_id=instance['image_ref'],
                                              reason=reason)
        # - single root pool only
        if not deployables[0].rootOnly:
            reason = _("Image contains more than one ZFS pool.")
            raise exception.ImageUnacceptable(image_id=instance['image_ref'],
                                              reason=reason)
        # - looks like it's OK
        self._validated_archives.append(instance['image_ref'])

    def _validate_flavor(self, instance):
        """Validate the flavor for compatibility with zone brands"""
        flavor = self._get_flavor(instance)
        extra_specs = flavor['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)

        if brand == ZONE_BRAND_SOLARIS_KZ:
            # verify the memory is 256mb aligned
            test_size = Size('256MB')
            instance_size = Size('%sMB' % instance['memory_mb'])

            if instance_size.byte_value % test_size.byte_value:
                # non-zero result so it doesn't align
                raise MemoryAlignmentIncorrect(
                    flavor=flavor['name'],
                    memsize=str(instance['memory_mb']),
                    align='256')

    def _suri_from_volume_info(self, connection_info):
        """Returns a suri(5) formatted string based on connection_info.
        Currently supports local ZFS volume, NFS, Fibre Channel and iSCSI
        driver types.
        """
        driver_type = connection_info['driver_volume_type']
        if driver_type not in ['iscsi', 'fibre_channel', 'local', 'nfs']:
            raise exception.VolumeDriverNotFound(driver_type=driver_type)
        if driver_type == 'local':
            suri = 'dev:/dev/zvol/dsk/%s' % connection_info['volume_path']
        elif driver_type == 'iscsi':
            data = connection_info['data']
            # suri(5) format:
            #       iscsi://<host>[:<port>]/target.<IQN>,lun.<LUN>
            # luname-only URI format for the multipathing:
            #       iscsi://<host>[:<port>]/luname.naa.<ID>
            # Sample iSCSI connection data values:
            # target_portal: 192.168.1.244:3260
            # target_iqn: iqn.2010-10.org.openstack:volume-a89c.....
            # target_lun: 1
            suri = None
            if 'target_iqns' in data:
                target = data['target_iqns'][0]
                target_lun = data['target_luns'][0]
                try:
                    utils.execute('/usr/sbin/iscsiadm', 'list', 'target',
                                  '-vS', target)
                    out, err = utils.execute('/usr/sbin/suriadm', 'lookup-uri',
                                             '-t', 'iscsi',
                                             '-p', 'target=%s' % target,
                                             '-p', 'lun=%s' % target_lun)
                    for line in [l.strip() for l in out.splitlines()]:
                        if "luname.naa." in line:
                            LOG.debug(_("The found luname-only URI for the "
                                      "LUN '%s' is '%s'.") %
                                      (target_lun, line))
                            suri = line
                except processutils.ProcessExecutionError as ex:
                    reason = ex.stderr
                    LOG.debug(_("Failed to lookup-uri for volume '%s', lun "
                              "'%s': '%s'.") % (target, target_lun, reason))

            if suri is None:
                suri = 'iscsi://%s/target.%s,lun.%d' % (data['target_portal'],
                                                        data['target_iqn'],
                                                        data['target_lun'])
            # TODO(npower): need to handle CHAP authentication also
        elif driver_type == 'nfs':
            data = connection_info['data']
            suri = (
                'nfs://cinder:cinder@%s/%s' %
                (data['export'].replace(':', ''), data['name'])
            )

        elif driver_type == 'fibre_channel':
            data = connection_info['data']
            target_wwn = data['target_wwn']
            # Ensure there's a fibre channel HBA.
            hbas = self._get_fc_hbas()
            if not hbas:
                LOG.error(_("Cannot attach Fibre Channel volume because "
                          "no Fibre Channel HBA initiators were found"))
                raise exception.InvalidVolume(
                    reason="No host Fibre Channel initiator found")

            target_lun = data['target_lun']
            # If the volume was exported just a few seconds previously then
            # it will probably not be visible to the local adapter yet.
            # Invoke 'fcinfo remote-port' on all local HBA ports to trigger
            # a refresh.
            for wwpn in self._get_fc_wwpns():
                utils.execute('/usr/sbin/fcinfo', 'remote-port', '-p', wwpn)

            suri = self._lookup_fc_volume_suri(target_wwn, target_lun)
        return suri

    def _lookup_fc_volume_suri(self, target_wwn, target_lun):
        """Searching the LU based URI for the FC LU. """
        wwns = []
        if isinstance(target_wwn, list):
            wwns = target_wwn
        else:
            wwns.append(target_wwn)

        for _none in range(3):
            for wwn in wwns:
                try:
                    out, err = utils.execute('/usr/sbin/suriadm', 'lookup-uri',
                                             '-p', 'target=naa.%s' % wwn,
                                             '-p', 'lun=%s' % target_lun)
                    for line in [l.strip() for l in out.splitlines()]:
                        if line.startswith("lu:luname.naa."):
                            return line
                except processutils.ProcessExecutionError as ex:
                    reason = ex.stderr
                    LOG.debug(_("Failed to lookup-uri for volume '%s', lun "
                              "%s: %s") % (wwn, target_lun, reason))
            greenthread.sleep(2)
        else:
            msg = _("Unable to lookup URI of Fibre Channel volume "
                    "with lun '%s'." % target_lun)
            raise exception.InvalidVolume(reason=msg)

    def _set_global_properties(self, name, extra_specs, brand):
        """Set Solaris Zone's global properties if supplied via flavor."""
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # TODO(dcomay): Should figure this out via the brands themselves.
        zonecfg_items = [
            'bootargs',
            'brand',
            'hostid'
        ]
        if brand == ZONE_BRAND_SOLARIS:
            zonecfg_items.extend(
                ['file-mac-profile', 'fs-allowed', 'limitpriv'])
        else:
            zonecfg_items.extend(['cpu-arch'])

        with ZoneConfig(zone) as zc:
            for key, value in extra_specs.iteritems():
                # Ignore not-zonecfg-scoped brand properties.
                if not key.startswith('zonecfg:'):
                    continue
                _scope, prop = key.split(':', 1)
                # Ignore the 'brand' property if present.
                if prop == 'brand':
                    continue
                # Ignore but warn about unsupported zonecfg-scoped properties.
                if prop not in zonecfg_items:
                    LOG.warning(_("Ignoring unsupported zone property '%s' "
                                  "set on flavor for instance '%s'")
                                % (prop, name))
                    continue
                zc.setprop('global', prop, value)

    def _create_boot_volume(self, context, instance):
        """Create a (Cinder) volume service backed boot volume"""
        boot_vol_az = CONF.solariszones.boot_volume_az
        boot_vol_type = CONF.solariszones.boot_volume_type
        try:
            vol = self._volume_api.create(
                context, instance['root_gb'],
                instance['hostname'] + "-" + self._rootzpool_suffix,
                "Boot volume for instance '%s' (%s)"
                % (instance['name'], instance['uuid']),
                volume_type=boot_vol_type, availability_zone=boot_vol_az)
            # TODO(npower): Polling is what nova/compute/manager also does when
            # creating a new volume, so we do likewise here.
            while True:
                volume = self._volume_api.get(context, vol['id'])
                if volume['status'] != 'creating':
                    return volume
                greenthread.sleep(1)

        except Exception as reason:
            LOG.exception(_("Unable to create root zpool volume for instance "
                            "'%s': %s") % (instance['name'], reason))
            raise

    def _connect_boot_volume(self, volume, mountpoint, context, instance):
        """Connect a (Cinder) volume service backed boot volume"""
        instance_uuid = instance['uuid']
        volume_id = volume['id']

        connector = self.get_volume_connector(instance)
        connection_info = self._volume_api.initialize_connection(context,
                                                                 volume_id,
                                                                 connector)
        connection_info['serial'] = volume_id

        # Check connection_info to determine if the provided volume is
        # local to this compute node. If it is, then don't use it for
        # Solaris branded zones in order to avoid a known ZFS deadlock issue
        # when using a zpool within another zpool on the same system.
        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        if brand == ZONE_BRAND_SOLARIS:
            driver_type = connection_info['driver_volume_type']
            if driver_type == 'local':
                msg = _("Detected 'local' zvol driver volume type "
                        "from volume service, which should not be "
                        "used as a boot device for 'solaris' "
                        "branded zones.")
                raise exception.InvalidVolume(reason=msg)
            elif driver_type == 'iscsi':
                # Check for a potential loopback iSCSI situation
                data = connection_info['data']
                target_portal = data['target_portal']
                # Strip off the port number (eg. 127.0.0.1:3260)
                host = target_portal.rsplit(':', 1)
                # Strip any enclosing '[' and ']' brackets for
                # IPv6 addresses.
                target_host = host[0].strip('[]')

                # Check if target_host is an IP or hostname matching the
                # connector host or IP, which would mean the provisioned
                # iSCSI LUN is on the same host as the instance.
                if target_host in [connector['ip'], connector['host']]:
                    msg = _("iSCSI connection info from volume "
                            "service indicates that the target is a "
                            "local volume, which should not be used "
                            "as a boot device for 'solaris' branded "
                            "zones.")
                    raise exception.InvalidVolume(reason=msg)
            # Assuming that fibre_channel is non-local
            elif driver_type != 'fibre_channel':
                # Some other connection type that we don't understand
                # Let zone use some local fallback instead.
                msg = _("Unsupported volume driver type '%s' can not be used "
                        "as a boot device for zones." % driver_type)
                raise exception.InvalidVolume(reason=msg)

        # Volume looks OK to use. Notify Cinder of the attachment.
        self._volume_api.attach(context, volume_id, instance_uuid, mountpoint)
        return connection_info

    def _set_boot_device(self, name, connection_info, brand):
        """Set the boot device specified by connection_info"""
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        suri = self._suri_from_volume_info(connection_info)

        with ZoneConfig(zone) as zc:
            # ZOSS device configuration is different for the solaris-kz brand
            if brand == ZONE_BRAND_SOLARIS_KZ:
                zc.zone.setResourceProperties(
                    zonemgr.Resource("device",
                                     [zonemgr.Property("bootpri", "0")]),
                    [zonemgr.Property("storage", suri)])
            else:
                zc.addresource(ROOTZPOOL_RESOURCE,
                               [zonemgr.Property("storage", listvalue=[suri])],
                               ignore_exists=True)

    def _set_num_cpu(self, name, vcpus, brand):
        """Set number of VCPUs in a Solaris Zone configuration."""
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # The Solaris Zone brand type is used to specify the type of
        # 'cpu' resource set in the Solaris Zone configuration.
        if brand == ZONE_BRAND_SOLARIS:
            vcpu_resource = 'capped-cpu'
        else:
            vcpu_resource = 'virtual-cpu'

        # TODO(dcomay): Until 17881862 is resolved, this should be turned into
        # an appropriate 'rctl' resource for the 'capped-cpu' case.
        with ZoneConfig(zone) as zc:
            zc.setprop(vcpu_resource, 'ncpus', str(vcpus))

    def _set_memory_cap(self, name, memory_mb, brand):
        """Set memory cap in a Solaris Zone configuration."""
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # The Solaris Zone brand type is used to specify the type of
        # 'memory' cap set in the Solaris Zone configuration.
        if brand == ZONE_BRAND_SOLARIS:
            mem_resource = 'swap'
        else:
            mem_resource = 'physical'

        with ZoneConfig(zone) as zc:
            zc.setprop('capped-memory', mem_resource, '%dM' % memory_mb)

    def _ovs_add_port(self, instance, vif, port):
        if vif['type'] == 'binding_failed':
            LOG.error(_('Port binding has failed for VIF %s. Ensure that '
                        'OVS agent is running and/or bridge_mappings are '
                        'correctly configured. VM will not have network '
                        'connectivity') % vif)

        ovs_bridge = CONF.neutron.ovs_bridge
        cmd = ['/usr/sbin/ovs-vsctl',
               '--timeout=%s' % CONF.ovs_vsctl_timeout,
               '--', '--if-exists', 'del-port', ovs_bridge, port,
               '--', 'add-port', ovs_bridge, port,
               '--', 'set', 'Interface', port,
               'external-ids:iface-id=%s' % vif['id'],
               'external-ids:iface-status=active',
               'external-ids:attached-mac=%s' % vif['address'],
               'external-ids:vm-uuid=%s' % instance['uuid']
               ]
        try:
            out, err = utils.execute(*cmd)
        except Exception as reason:
            msg = (_("Failed to add port '%s' with MAC address '%s' to "
                     "OVS Bridge '%s': %s")
                   % (port, vif['address'], ovs_bridge, reason))
            raise exception.NovaException(msg)
        LOG.debug(_('Successfully added port %s with MAC adddress %s') %
                  (port, vif['address']))

    def _ovs_delete_port(self, port, log_warnings=False):
        ovs_bridge = CONF.neutron.ovs_bridge
        cmd = ['/usr/sbin/ovs-vsctl',
               '--timeout=%s' % CONF.ovs_vsctl_timeout,
               '--', '--if-exists', 'del-port', ovs_bridge, port]
        try:
            out, err = utils.execute(*cmd)
            LOG.debug(_('Removed port %s from the OVS bridge %s') %
                      (port, ovs_bridge))
        except Exception as reason:
            msg = (_("Unable to remove port '%s' from the OVS "
                     "bridge '%s': %s") % (port, ovs_bridge, reason))
            if log_warnings:
                LOG.warning(msg)
            else:
                raise nova.exception.NovaException(msg)

    def _plug_vifs(self, instance, network_info):
        if not network_info:
            LOG.debug(_("Instance has no VIF. Nothing to plug."))
            return

        # first find out all the anets for a given instance
        try:
            out, err = utils.execute('/usr/sbin/dladm', 'show-vnic',
                                     '-z', instance['name'],
                                     '-po', 'link,macaddress')
        except Exception as reason:
            msg = (_("Unable to get interfaces for instance '%s': %s")
                   % (instance['name'], reason))
            raise exception.NovaException(msg)

        anetdict = {}
        for anet_maddr in out.strip().splitlines():
            anet, maddr = anet_maddr.strip().split(':', 1)
            maddr = maddr.replace('\\', '')
            maddr = ''.join(['%02x' % int(b, 16) for b in maddr.split(':')])
            anetdict[maddr] = anet

        LOG.debug(_("List of instance %s's anets: %s")
                  % (instance['name'], anetdict))
        # we now have a list of VNICs that belong to the VM
        # we need to map the VNIC to the bridge
        for vif in network_info:
            vif_maddr = ''.join(['%02x' % int(b, 16) for b in
                                 vif['address'].split(':')])
            anet = anetdict.get(vif_maddr)
            if anet is None:
                LOG.error(_('Failed to add port %s connected to network %s '
                            'to instance %s')
                          % (vif['ovs_interfaceid'], vif['network']['id'],
                             instance['name']))
                continue
            self._ovs_add_port(instance, vif, anet)

    def _unplug_vifs(self, instance):
        ovs_bridge = CONF.neutron.ovs_bridge
        # remove the anets from the OVS bridge
        cmd = ['/usr/sbin/ovs-vsctl', '--timeout=%s' % CONF.ovs_vsctl_timeout,
               'list-ports', ovs_bridge]
        try:
            out, err = utils.execute(*cmd)
        except Exception as reason:
            msg = (_("Unable to get interfaces for instance '%s': %s")
                   % (instance['name'], reason))
            raise exception.NovaException(msg)

        for port in out.strip().splitlines():
            if port.split('/')[0] != instance['name']:
                continue
            self._ovs_delete_port(port, log_warnings=True)

    def _set_ovs_info(self, context, zone, brand, first_anet, vif):
        # Need to be admin to retrieve provider:network_type attribute
        network_plugin = neutronv2_api.get_client(context, admin=True)
        network = network_plugin.show_network(
            vif['network']['id'])['network']
        network_type = network['provider:network_type']
        lower_link = None
        if network_type == 'vxlan':
            lower_link = 'ovs.vxlan1'
        elif network_type in ['vlan', 'flat']:
            physical_network = network['provider:physical_network']
            # retrieve the other_config information from Open_vSwitch table
            try:
                results = get_ovsdb_info('Open_vSwitch', ['other_config'])
            except Exception as err:
                LOG.exception(_("Failed to retrieve other_config: %s"), err)
                raise

            other_config = results[0]['other_config']
            if not other_config:
                msg = (_("'other_config' column in 'Open_vSwitch' OVSDB table "
                         "is not configured. Please configure it so that the "
                         "lower-link can be determined for the instance's "
                         "interface."))
                LOG.error(msg)
                raise exception.NovaException(msg)
            bridge_mappings = other_config.get('bridge_mappings')
            if not bridge_mappings:
                msg = (_("'bridge_mappings' info is not set in the "
                         "'other_config' column of 'Open_vSwitch' OVSDB "
                         "table. Please configure it so that the lower-link "
                         "can be determined for the instance's interface."))
                LOG.error(msg)
                raise exception.NovaException(msg)
            for bridge_mapping in bridge_mappings.split(','):
                if physical_network in bridge_mapping:
                    lower_link = bridge_mapping.split(':')[1]
                    break
            if not lower_link:
                msg = (_("Failed to determine the lower_link for vif '%s'.") %
                       (vif))
                LOG.error(msg)
                raise exception.NovaException(msg)
        else:
            # TYPE_GRE and TYPE_LOCAL
            msg = (_("Unsupported network type: %s") % network_type)
            LOG.error(msg)
            raise exception.NovaException(msg)

        mtu = network['mtu']
        with ZoneConfig(zone) as zc:
            if first_anet:
                zc.setprop('anet', 'lower-link', lower_link)
                zc.setprop('anet', 'configure-allowed-address', 'false')
                zc.setprop('anet', 'mac-address', vif['address'])
                if mtu > 0:
                    zc.setprop('anet', 'mtu', str(mtu))
            else:
                props = [zonemgr.Property('lower-link', lower_link),
                         zonemgr.Property('configure-allowed-address',
                                          'false'),
                         zonemgr.Property('mac-address', vif['address'])]
                if mtu > 0:
                    props.append(zonemgr.Property('mtu', str(mtu)))
                zc.addresource('anet', props)

            prop_filter = [zonemgr.Property('mac-address', vif['address'])]
            if brand == ZONE_BRAND_SOLARIS:
                anetname = lookup_resource_property(zc.zone, 'anet',
                                                    'linkname', prop_filter)
            else:
                anetid = lookup_resource_property(zc.zone, 'anet', 'id',
                                                  prop_filter)
                anetname = 'net%s' % anetid
        return anetname

    def _set_network(self, context, name, instance, network_info, brand,
                     sc_dir):
        """add networking information to the zone."""
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if not network_info:
            with ZoneConfig(zone) as zc:
                if brand == ZONE_BRAND_SOLARIS:
                    zc.removeresources("anet",
                                       [zonemgr.Property("linkname", "net0")])
                else:
                    zc.removeresources("anet", [zonemgr.Property("id", "0")])
                return

        for vifid, vif in enumerate(network_info):
            LOG.debug("%s", jsonutils.dumps(vif, indent=5))

            ip = vif['network']['subnets'][0]['ips'][0]['address']
            cidr = vif['network']['subnets'][0]['cidr']
            ip_cidr = "%s/%s" % (ip, cidr.split('/')[1])
            ip_version = vif['network']['subnets'][0]['version']
            dhcp_server = \
                vif['network']['subnets'][0]['meta'].get('dhcp_server')
            enable_dhcp = dhcp_server is not None
            route = vif['network']['subnets'][0]['gateway']['address']
            dns_list = vif['network']['subnets'][0]['dns']
            nameservers = []
            for dns in dns_list:
                if dns['type'] == 'dns':
                    nameservers.append(dns['address'])

            anetname = self._set_ovs_info(context, zone, brand, vifid == 0,
                                          vif)

            # create the required sysconfig file (or skip if this is part of a
            # resize or evacuate process)
            tstate = instance['task_state']
            if tstate not in [task_states.RESIZE_FINISH,
                              task_states.RESIZE_REVERTING,
                              task_states.RESIZE_MIGRATING,
                              task_states.REBUILD_SPAWNING] or \
                (tstate == task_states.REBUILD_SPAWNING and
                 instance.system_metadata['rebuilding'] == 'true'):
                if enable_dhcp:
                    tree = sysconfig.create_ncp_defaultfixed('dhcp',
                                                             anetname, vifid,
                                                             ip_version)
                else:
                    host_routes = vif['network']['subnets'][0]['routes']
                    tree = sysconfig.create_ncp_defaultfixed('static',
                                                             anetname, vifid,
                                                             ip_version,
                                                             ip_cidr, route,
                                                             nameservers,
                                                             host_routes)

                fp = os.path.join(sc_dir, 'zone-network-%d.xml' % vifid)
                sysconfig.create_sc_profile(fp, tree)

    def _set_suspend(self, instance):
        """Use the instance name to specify the pathname for the suspend image.
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        path = os.path.join(CONF.solariszones.zones_suspend_path,
                            '%{zonename}')
        with ZoneConfig(zone) as zc:
            zc.addresource('suspend', [zonemgr.Property('path', path)])

    def _verify_sysconfig(self, sc_dir, instance, admin_password=None):
        """verify the SC profile(s) passed in contain an entry for
        system/config-user to configure the root account.  If an SSH key is
        specified, configure root's profile to use it.
        """
        usercheck = lambda e: e.attrib.get('name') == 'system/config-user'
        hostcheck = lambda e: e.attrib.get('name') == 'system/identity'

        root_account_needed = True
        hostname_needed = True
        sshkey = instance.get('key_data')
        name = instance.get('hostname')
        encrypted_password = None

        # encrypt admin password, using SHA-256 as default
        if admin_password is not None:
            encrypted_password = sha256_crypt.encrypt(admin_password)

        # find all XML files in sc_dir
        for root, dirs, files in os.walk(sc_dir):
            for fname in [f for f in files if f.endswith(".xml")]:
                fileroot = etree.parse(os.path.join(root, fname))

                # look for config-user properties
                if filter(usercheck, fileroot.findall('service')):
                    # a service element was found for config-user.  Verify
                    # root's password is set, the admin account name is set and
                    # the admin's password is set
                    pgs = fileroot.iter('property_group')
                    for pg in pgs:
                        if pg.attrib.get('name') == 'root_account':
                            root_account_needed = False

                # look for identity properties
                if filter(hostcheck, fileroot.findall('service')):
                    for props in fileroot.iter('propval'):
                        if props.attrib.get('name') == 'nodename':
                            hostname_needed = False

        # Verify all of the requirements were met.  Create the required SMF
        # profile(s) if needed.
        if root_account_needed:
            fp = os.path.join(sc_dir, 'config-root.xml')

            if admin_password is not None and sshkey is not None:
                # store password for horizon retrieval
                ctxt = nova_context.get_admin_context()
                enc = crypto.ssh_encrypt_text(sshkey, admin_password)
                instance.system_metadata.update(
                    password.convert_password(ctxt, base64.b64encode(enc)))
                instance.save()

            if encrypted_password is not None or sshkey is not None:
                # set up the root account as 'normal' with no expiration,
                # an ssh key, and a root password
                tree = sysconfig.create_default_root_account(
                    sshkey=sshkey, password=encrypted_password)
            else:
                # sets up root account with expiration if sshkey is None
                # and password is none
                tree = sysconfig.create_default_root_account(expire='0')

            sysconfig.create_sc_profile(fp, tree)

        elif sshkey is not None:
            fp = os.path.join(sc_dir, 'config-root-ssh-keys.xml')
            tree = sysconfig.create_root_ssh_keys(sshkey)
            sysconfig.create_sc_profile(fp, tree)

        if hostname_needed and name is not None:
            fp = os.path.join(sc_dir, 'hostname.xml')
            sysconfig.create_sc_profile(fp, sysconfig.create_hostname(name))

    def _create_config(self, context, instance, network_info, connection_info,
                       sc_dir, admin_password=None):
        """Create a new Solaris Zone configuration."""
        name = instance['name']
        if self._get_zone_by_name(name) is not None:
            raise exception.InstanceExists(name=name)

        flavor = self._get_flavor(instance)
        extra_specs = flavor['extra_specs'].copy()

        # If unspecified, default zone brand is ZONE_BRAND_SOLARIS
        brand = extra_specs.get('zonecfg:brand')
        if brand is None:
            LOG.warning(_("'zonecfg:brand' key not found in extra specs for "
                          "flavor '%s'.  Defaulting to 'solaris'"
                        % flavor['name']))

            brand = ZONE_BRAND_SOLARIS

        template = ZONE_BRAND_TEMPLATE.get(brand)
        # TODO(dcomay): Detect capability via libv12n(3LIB) or virtinfo(1M).
        if template is None:
            msg = (_("Invalid brand '%s' specified for instance '%s'"
                   % (brand, name)))
            raise exception.NovaException(msg)

        tstate = instance['task_state']
        if tstate not in [task_states.RESIZE_FINISH,
                          task_states.RESIZE_REVERTING,
                          task_states.RESIZE_MIGRATING,
                          task_states.REBUILD_SPAWNING] or \
            (tstate == task_states.REBUILD_SPAWNING and
             instance.system_metadata['rebuilding'] == 'true'):
            sc_profile = extra_specs.get('install:sc_profile')
            if sc_profile is not None:
                if os.path.isfile(sc_profile):
                    shutil.copy(sc_profile, sc_dir)
                elif os.path.isdir(sc_profile):
                    shutil.copytree(sc_profile,
                                    os.path.join(sc_dir, 'sysconfig'))

            self._verify_sysconfig(sc_dir, instance, admin_password)

        LOG.debug(_("Creating zone configuration for '%s' (%s)")
                  % (name, instance['display_name']))
        try:
            self.zone_manager.create(name, None, template)
            self._set_global_properties(name, extra_specs, brand)
            hostid = instance.system_metadata.get('hostid')
            if hostid:
                zone = self._get_zone_by_name(name)
                with ZoneConfig(zone) as zc:
                    zc.setprop('global', 'hostid', hostid)

            if connection_info is not None:
                self._set_boot_device(name, connection_info, brand)
            self._set_num_cpu(name, instance['vcpus'], brand)
            self._set_memory_cap(name, instance['memory_mb'], brand)
            self._set_network(context, name, instance, network_info, brand,
                              sc_dir)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to create configuration for instance '%s' "
                            "via zonemgr(3RAD): %s") % (name, reason))
            raise

    def _create_vnc_console_service(self, instance):
        """Create a VNC console SMF service for a Solaris Zone"""
        # Basic environment checks first: vncserver and xterm
        if not os.path.exists(VNC_SERVER_PATH):
            LOG.warning(_("Zone VNC console SMF service not available on this "
                          "compute node. %s is missing. Run 'pkg install "
                          "x11/server/xvnc'") % VNC_SERVER_PATH)
            raise exception.ConsoleTypeUnavailable(console_type='vnc')

        if not os.path.exists(XTERM_PATH):
            LOG.warning(_("Zone VNC console SMF service not available on this "
                          "compute node. %s is missing. Run 'pkg install "
                          "terminal/xterm'") % XTERM_PATH)
            raise exception.ConsoleTypeUnavailable(console_type='vnc')

        name = instance['name']
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            out, err = utils.execute('/usr/sbin/svccfg',
                                     '-s', VNC_CONSOLE_BASE_FMRI, 'add', name)
        except processutils.ProcessExecutionError as ex:
            if self._has_vnc_console_service(instance):
                LOG.debug(_("Ignoring attempt to create existing zone VNC "
                            "console SMF service for instance '%s'") % name)
                return
            reason = ex.stderr
            LOG.exception(_("Unable to create zone VNC console SMF service "
                            "'{0}': {1}").format(VNC_CONSOLE_BASE_FMRI + ':' +
                                                 name, reason))
            raise

    def _delete_vnc_console_service(self, instance):
        """Delete a VNC console SMF service for a Solaris Zone"""
        name = instance['name']
        self._disable_vnc_console_service(instance)
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            out, err = utils.execute('/usr/sbin/svccfg',
                                     '-s', VNC_CONSOLE_BASE_FMRI, 'delete',
                                     name)
        except processutils.ProcessExecutionError as ex:
            if not self._has_vnc_console_service(instance):
                LOG.debug(_("Ignoring attempt to delete a non-existent zone "
                            "VNC console SMF service for instance '%s'")
                          % name)
                return
            reason = ex.stderr
            LOG.exception(_("Unable to delete zone VNC console SMF service "
                            "'%s': %s")
                          % (VNC_CONSOLE_BASE_FMRI + ':' + name, reason))
            raise

    def _enable_vnc_console_service(self, instance):
        """Enable a zone VNC console SMF service"""
        name = instance['name']

        console_fmri = VNC_CONSOLE_BASE_FMRI + ':' + name
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            # The console SMF service exits with SMF_TEMP_DISABLE to prevent
            # unnecessarily coming online at boot. Tell it to really bring
            # it online.
            out, err = utils.execute('/usr/sbin/svccfg', '-s', console_fmri,
                                     'setprop', 'vnc/nova-enabled=true')
            out, err = utils.execute('/usr/sbin/svccfg', '-s', console_fmri,
                                     'refresh')
            out, err = utils.execute('/usr/sbin/svcadm', 'enable',
                                     console_fmri)
        except processutils.ProcessExecutionError as ex:
            if not self._has_vnc_console_service(instance):
                LOG.debug(_("Ignoring attempt to enable a non-existent zone "
                            "VNC console SMF service for instance '%s'")
                          % name)
                return
            reason = ex.stderr
            LOG.exception(_("Unable to start zone VNC console SMF service "
                            "'%s': %s") % (console_fmri, reason))
            raise

        # Allow some time for the console service to come online.
        greenthread.sleep(2)
        while True:
            try:
                out, err = utils.execute('/usr/bin/svcs', '-H', '-o', 'state',
                                         console_fmri)
                state = out.strip()
                if state == 'online':
                    break
                elif state in ['maintenance', 'offline']:
                    LOG.error(_("Zone VNC console SMF service '%s' is in the "
                                "'%s' state. Run 'svcs -x %s' for details.")
                              % (console_fmri, state, console_fmri))
                    raise exception.ConsoleNotFoundForInstance(
                        instance_uuid=instance['uuid'])
                # Wait for service state to transition to (hopefully) online
                # state or offline/maintenance states.
                greenthread.sleep(2)
            except processutils.ProcessExecutionError as ex:
                reason = ex.stderr
                LOG.exception(_("Error querying state of zone VNC console SMF "
                                "service '%s': %s") % (console_fmri, reason))
                raise
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            # The console SMF service exits with SMF_TEMP_DISABLE to prevent
            # unnecessarily coming online at boot. Make that happen.
            out, err = utils.execute('/usr/sbin/svccfg', '-s', console_fmri,
                                     'setprop', 'vnc/nova-enabled=false')
            out, err = utils.execute('/usr/sbin/svccfg', '-s', console_fmri,
                                     'refresh')
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Unable to update 'vnc/nova-enabled' property for "
                            "zone VNC console SMF service '%s': %s")
                          % (console_fmri, reason))
            raise

    def _disable_vnc_console_service(self, instance):
        """Disable a zone VNC console SMF service"""
        name = instance['name']
        if not self._has_vnc_console_service(instance):
            LOG.debug(_("Ignoring attempt to disable a non-existent zone VNC "
                        "console SMF service for instance '%s'") % name)
            return
        console_fmri = VNC_CONSOLE_BASE_FMRI + ':' + name
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            out, err = utils.execute('/usr/sbin/svcadm', 'disable',
                                     '-s', console_fmri)
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Unable to disable zone VNC console SMF service "
                            "'%s': %s") % (console_fmri, reason))
        # The console service sets a SMF instance property for the port
        # on which the VNC service is listening. The service needs to be
        # refreshed to reset the property value
        try:
            out, err = utils.execute('/usr/sbin/svccfg', '-s', console_fmri,
                                     'refresh')
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Unable to refresh zone VNC console SMF service "
                            "'%s': %s") % (console_fmri, reason))

    def _get_vnc_console_service_state(self, instance):
        """Returns state of the instance zone VNC console SMF service"""
        name = instance['name']
        if not self._has_vnc_console_service(instance):
            LOG.warning(_("Console state requested for a non-existent zone "
                          "VNC console SMF service for instance '%s'")
                        % name)
            return None
        console_fmri = VNC_CONSOLE_BASE_FMRI + ':' + name
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            state, err = utils.execute('/usr/sbin/svcs', '-H', '-o', 'state',
                                       console_fmri)
            return state.strip()
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Console state request failed for zone VNC "
                            "console SMF service for instance '%s': %s")
                          % (name, reason))
            raise

    def _has_vnc_console_service(self, instance):
        """Returns True if the instance has a zone VNC console SMF service"""
        name = instance['name']
        console_fmri = VNC_CONSOLE_BASE_FMRI + ':' + name
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            utils.execute('/usr/bin/svcs', '-H', '-o', 'state', console_fmri)
            return True
        except Exception:
            return False

    def _install(self, instance, image, sc_dir):
        """Install a new Solaris Zone root file system."""
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # log the zone's configuration
        with ZoneConfig(zone) as zc:
            LOG.debug("-" * 80)
            LOG.debug(zc.zone.exportConfig(True))
            LOG.debug("-" * 80)

        options = ['-a', image]

        if os.listdir(sc_dir):
            # the directory isn't empty so pass it along to install
            options.extend(['-c', sc_dir])

        try:
            LOG.debug(_("Installing instance '%s' (%s)") %
                      (name, instance['display_name']))
            zone.install(options=options)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to install root file system for instance "
                            "'%s' via zonemgr(3RAD): %s") % (name, reason))
            raise

        self._set_instance_metahostid(instance)

        LOG.debug(_("Installation of instance '%s' (%s) complete") %
                  (name, instance['display_name']))

    def _power_on(self, instance, network_info):
        """Power on a Solaris Zone."""
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # Attempt to update the zones hostid in the instance data, to catch
        # those instances that might have been created without a hostid stored.
        self._set_instance_metahostid(instance)

        bootargs = []
        if CONF.solariszones.solariszones_boot_options:
            reset_bootargs = False
            persistent = 'False'

            # Get any bootargs already set in the zone
            cur_bootargs = lookup_resource_property(zone, 'global', 'bootargs')

            # Get any bootargs set in the instance metadata by the user
            meta_bootargs = instance.metadata.get('bootargs')

            if meta_bootargs:
                bootargs = ['--', str(meta_bootargs)]
                persistent = str(
                    instance.metadata.get('bootargs_persist', 'False'))
                if cur_bootargs is not None and meta_bootargs != cur_bootargs:
                    with ZoneConfig(zone) as zc:
                        reset_bootargs = True
                        # Temporarily clear bootargs in zone config
                        zc.clear_resource_props('global', ['bootargs'])

        try:
            zone.boot(bootargs)
            self._plug_vifs(instance, network_info)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to power on instance '%s' via "
                            "zonemgr(3RAD): %s") % (name, reason))
            raise exception.InstancePowerOnFailure(reason=reason)
        finally:
            if CONF.solariszones.solariszones_boot_options:
                if meta_bootargs and persistent.lower() == 'false':
                    # We have consumed the metadata bootargs and
                    # the user asked for them not to be persistent so
                    # clear them out now.
                    instance.metadata.pop('bootargs', None)
                    instance.metadata.pop('bootargs_persist', None)

                if reset_bootargs:
                    with ZoneConfig(zone) as zc:
                        # restore original boot args in zone config
                        zc.setprop('global', 'bootargs', cur_bootargs)

    def _uninstall(self, instance):
        """Uninstall an existing Solaris Zone root file system."""
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if zone.state == ZONE_STATE_CONFIGURED:
            LOG.debug(_("Uninstall not required for zone '%s' in state '%s'")
                      % (name, zone.state))
            return
        try:
            zone.uninstall(['-F'])
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to uninstall root file system for "
                            "instance '%s' via zonemgr(3RAD): %s")
                          % (name, reason))
            raise

    def _delete_config(self, instance):
        """Delete an existing Solaris Zone configuration."""
        name = instance['name']
        if self._get_zone_by_name(name) is None:
            raise exception.InstanceNotFound(instance_id=name)

        try:
            self.zone_manager.delete(name)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to delete configuration for instance '%s' "
                            "via zonemgr(3RAD): %s") % (name, reason))
            raise

    def spawn(self, context, instance, image_meta, injected_files,
              admin_password, network_info=None, block_device_info=None):
        """Create a new instance/VM/domain on the virtualization platform.

        Once this successfully completes, the instance should be
        running (power_state.RUNNING).

        If this fails, any partial instance should be completely
        cleaned up, and the virtualization platform should be in the state
        that it was before this call began.

        :param context: security context
        :param instance: nova.objects.instance.Instance
                         This function should use the data there to guide
                         the creation of the new instance.
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        :param injected_files: User files to inject into instance.
        :param admin_password: Administrator password to set in instance.
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param block_device_info: Information about block devices to be
                                  attached to the instance.
        """
        image = self._fetch_image(context, instance)
        self._validate_image(context, image, instance)
        self._validate_flavor(instance)

        # c1d0 is the standard dev for the default boot device.
        # Irrelevant value for ZFS, but Cinder gets stroppy without it.
        mountpoint = "c1d0"

        # Ensure no block device mappings attempt to use the reserved boot
        # device (c1d0).
        for entry in block_device_info.get('block_device_mapping'):
            if entry['connection_info'] is None:
                continue

            mount_device = entry['mount_device']
            if mount_device == '/dev/' + mountpoint:
                msg = (_("Unable to assign '%s' to block device as it is"
                         "reserved for the root file system") % mount_device)
                raise exception.InvalidDiskInfo(msg)

        # Attempt to provision a (Cinder) volume service backed boot volume
        volume = self._create_boot_volume(context, instance)
        volume_id = volume['id']
        name = instance['name']
        try:
            connection_info = self._connect_boot_volume(volume, mountpoint,
                                                        context, instance)
        except exception.InvalidVolume as reason:
            # This Cinder volume is not usable for ZOSS so discard it.
            # zonecfg will apply default zonepath dataset configuration
            # instead. Carry on
            LOG.warning(_("Volume '%s' is being discarded: %s")
                        % (volume_id, reason))
            self._volume_api.delete(context, volume_id)
            connection_info = None
        except Exception as reason:
            # Something really bad happened. Don't pass Go.
            LOG.exception(_("Unable to attach root zpool volume '%s' to "
                            "instance %s: %s") % (volume['id'], name, reason))
            self._volume_api.delete(context, volume_id)
            raise

        # create a new directory for SC profiles
        sc_dir = tempfile.mkdtemp(prefix="nova-sysconfig-",
                                  dir=CONF.state_path)
        os.chmod(sc_dir, 0755)

        try:
            self._create_config(context, instance, network_info,
                                connection_info, sc_dir, admin_password)
            self._install(instance, image, sc_dir)

            for entry in block_device_info.get('block_device_mapping'):
                if entry['connection_info'] is not None:
                    self.attach_volume(context, entry['connection_info'],
                                       instance, entry['mount_device'])

            self._power_on(instance, network_info)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to spawn instance '%s' via zonemgr(3RAD): "
                            "'%s'") % (name, reason))
            # At least attempt to uninstall the instance, depending on where
            # the installation got to there could be things left behind that
            # need to be cleaned up, e.g a root zpool etc.
            try:
                self._uninstall(instance)
            except Exception as ex:
                reason = zonemgr_strerror(ex)
                LOG.debug(_("Unable to uninstall instance '%s' via "
                            "zonemgr(3RAD): %s") % (name, reason))
            try:
                self._delete_config(instance)
            except Exception as ex:
                reason = zonemgr_strerror(ex)
                LOG.debug(_("Unable to unconfigure instance '%s' via "
                            "zonemgr(3RAD): %s") % (name, reason))

            if connection_info is not None:
                self._volume_api.detach(context, volume_id)
                self._volume_api.delete(context, volume_id)
            raise
        finally:
            # remove the sc_profile temp directory
            shutil.rmtree(sc_dir)

        if connection_info is not None:
            bdm_obj = objects.BlockDeviceMappingList()
            # there's only one bdm for this instance at this point
            bdm = bdm_obj.get_by_instance_uuid(
                context, instance.uuid).objects[0]

            # update the required attributes
            bdm['connection_info'] = jsonutils.dumps(connection_info)
            bdm['source_type'] = 'volume'
            bdm['destination_type'] = 'volume'
            bdm['device_name'] = mountpoint
            bdm['delete_on_termination'] = True
            bdm['volume_id'] = volume_id
            bdm['volume_size'] = instance['root_gb']
            bdm.save()

    def _power_off(self, instance, halt_type):
        """Power off a Solaris Zone."""
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # Attempt to update the zones hostid in the instance data, to catch
        # those instances that might have been created without a hostid stored.
        self._set_instance_metahostid(instance)

        try:
            self._unplug_vifs(instance)
            if halt_type == 'SOFT':
                zone.shutdown()
            else:
                # 'HARD'
                zone.halt()
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            # A shutdown state could still be reached if the error was
            # informational and ignorable.
            if self._get_state(zone) == power_state.SHUTDOWN:
                LOG.warning(_("Ignoring command error returned while "
                              "trying to power off instance '%s' via "
                              "zonemgr(3RAD): %s" % (name, reason)))
                return

            LOG.exception(_("Unable to power off instance '%s' "
                            "via zonemgr(3RAD): %s") % (name, reason))
            raise exception.InstancePowerOffFailure(reason=reason)

    def _samehost_revert_resize(self, context, instance, network_info,
                                block_device_info):
        """Reverts the zones configuration to pre-resize config
        """
        self.power_off(instance)

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)

        name = instance['name']

        self._set_num_cpu(name, instance.vcpus, brand)
        self._set_memory_cap(name, instance.memory_mb, brand)

        rgb = instance.root_gb
        old_rvid = instance.system_metadata.get('old_instance_volid')
        if old_rvid:
            new_rvid = instance.system_metadata.get('new_instance_volid')
            mount_dev = instance['root_device_name']
            del instance.system_metadata['old_instance_volid']

            self._resize_disk_migration(context, instance, new_rvid, old_rvid,
                                        rgb, mount_dev)

    def destroy(self, context, instance, network_info, block_device_info=None,
                destroy_disks=True, migrate_data=None):
        """Destroy the specified instance from the Hypervisor.

        If the instance is not found (for example if networking failed), this
        function should still succeed.  It's probably a good idea to log a
        warning in that case.

        :param context: security context
        :param instance: Instance object as returned by DB layer.
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param block_device_info: Information about block devices that should
                                  be detached from the instance.
        :param destroy_disks: Indicates if disks should be destroyed
        :param migrate_data: implementation specific params
        """
        if (instance['task_state'] == task_states.RESIZE_REVERTING and
                instance.system_metadata['old_vm_state'] == vm_states.RESIZED):
            return

        # A destroy is issued for the original zone for an evac case.  If
        # the evac fails we need to protect the zone from deletion when
        # power comes back on.
        evac_from = instance.system_metadata.get('evac_from')
        if evac_from is not None and instance['task_state'] is None:
            instance.host = evac_from
            instance.node = evac_from
            del instance.system_metadata['evac_from']
            instance.save()

            return

        try:
            # These methods log if problems occur so no need to double log
            # here. Just catch any stray exceptions and allow destroy to
            # proceed.
            if self._has_vnc_console_service(instance):
                self._disable_vnc_console_service(instance)
                self._delete_vnc_console_service(instance)
        except Exception:
            pass

        name = instance['name']
        zone = self._get_zone_by_name(name)
        # If instance cannot be found, just return.
        if zone is None:
            LOG.warning(_("Unable to find instance '%s' via zonemgr(3RAD)")
                        % name)
            return

        try:
            if self._get_state(zone) == power_state.RUNNING:
                self._power_off(instance, 'HARD')
            if self._get_state(zone) == power_state.SHUTDOWN:
                self._uninstall(instance)
            if self._get_state(zone) == power_state.NOSTATE:
                self._delete_config(instance)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.warning(_("Unable to destroy instance '%s' via zonemgr(3RAD): "
                          "%s") % (name, reason))

        # One last point of house keeping. If we are deleting the instance
        # during a resize operation we want to make sure the cinder volumes are
        # properly cleaned up. We need to do this here, because the periodic
        # task that comes along and cleans these things up isn't nice enough to
        # pass a context in so that we could simply do the work there.  But
        # because we have access to a context, we can handle the work here and
        # let the periodic task simply clean up the left over zone
        # configuration that might be left around.  Note that the left over
        # zone will only show up in zoneadm list, not nova list.
        #
        # If the task state is RESIZE_REVERTING do not process these because
        # the cinder volume cleanup is taken care of in
        # finish_revert_migration.
        if instance['task_state'] == task_states.RESIZE_REVERTING:
            return

        tags = ['old_instance_volid', 'new_instance_volid']
        for tag in tags:
            volid = instance.system_metadata.get(tag)
            if volid:
                try:
                    LOG.debug(_("Deleting volume %s"), volid)
                    self._volume_api.delete(context, volid)
                    del instance.system_metadata[tag]
                except Exception:
                    pass

    def cleanup(self, context, instance, network_info, block_device_info=None,
                destroy_disks=True, migrate_data=None, destroy_vifs=True):
        """Cleanup the instance resources .

        Instance should have been destroyed from the Hypervisor before calling
        this method.

        :param context: security context
        :param instance: Instance object as returned by DB layer.
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param block_device_info: Information about block devices that should
                                  be detached from the instance.
        :param destroy_disks: Indicates if disks should be destroyed
        :param migrate_data: implementation specific params
        """
        raise NotImplementedError()

    def reboot(self, context, instance, network_info, reboot_type,
               block_device_info=None, bad_volumes_callback=None):
        """Reboot the specified instance.

        After this is called successfully, the instance's state
        goes back to power_state.RUNNING. The virtualization
        platform should ensure that the reboot action has completed
        successfully even in cases in which the underlying domain/vm
        is paused or halted/stopped.

        :param instance: nova.objects.instance.Instance
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param reboot_type: Either a HARD or SOFT reboot
        :param block_device_info: Info pertaining to attached volumes
        :param bad_volumes_callback: Function to handle any bad volumes
            encountered
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if self._get_state(zone) == power_state.SHUTDOWN:
            self._power_on(instance, network_info)
            return

        bootargs = []
        if CONF.solariszones.solariszones_boot_options:
            reset_bootargs = False
            persistent = 'False'

            # Get any bootargs already set in the zone
            cur_bootargs = lookup_resource_property(zone, 'global', 'bootargs')

            # Get any bootargs set in the instance metadata by the user
            meta_bootargs = instance.metadata.get('bootargs')

            if meta_bootargs:
                bootargs = ['--', str(meta_bootargs)]
                persistent = str(
                    instance.metadata.get('bootargs_persist', 'False'))
                if cur_bootargs is not None and meta_bootargs != cur_bootargs:
                    with ZoneConfig(zone) as zc:
                        reset_bootargs = True
                        # Temporarily clear bootargs in zone config
                        zc.clear_resource_props('global', ['bootargs'])

        try:
            self._unplug_vifs(instance)
            if reboot_type == 'SOFT':
                bootargs.insert(0, '-r')
                zone.shutdown(bootargs)
            else:
                zone.reboot(bootargs)
            self._plug_vifs(instance, network_info)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to reboot instance '%s' via "
                            "zonemgr(3RAD): %s") % (name, reason))
            raise exception.InstanceRebootFailure(reason=reason)
        finally:
            if CONF.solariszones.solariszones_boot_options:
                if meta_bootargs and persistent.lower() == 'false':
                    # We have consumed the metadata bootargs and
                    # the user asked for them not to be persistent so
                    # clear them out now.
                    instance.metadata.pop('bootargs', None)
                    instance.metadata.pop('bootargs_persist', None)

                if reset_bootargs:
                    with ZoneConfig(zone) as zc:
                        # restore original boot args in zone config
                        zc.setprop('global', 'bootargs', cur_bootargs)

    def get_console_pool_info(self, console_type):
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def _get_console_output(self, instance):
        """Builds a string containing the console output (capped at
        MAX_CONSOLE_BYTES characters) by reassembling the log files
        that Solaris Zones framework maintains for each zone.
        """
        console_str = ""
        avail = MAX_CONSOLE_BYTES

        # Examine the log files in most-recently modified order, keeping
        # track of the size of each file and of how many characters have
        # been seen. If there are still characters left to incorporate,
        # then the contents of the log file in question are prepended to
        # the console string built so far. When the number of characters
        # available has run out, the last fragment under consideration
        # will likely begin within the middle of a line. As such, the
        # start of the fragment up to the next newline is thrown away.
        # The remainder constitutes the start of the resulting console
        # output which is then prepended to the console string built so
        # far and the result returned.
        logfile_pattern = '/var/log/zones/%s.console*' % instance['name']
        logfiles = sorted(glob.glob(logfile_pattern), key=os.path.getmtime,
                          reverse=True)
        for file in logfiles:
            size = os.path.getsize(file)
            if size == 0:
                continue
            avail -= size
            with open(file, 'r') as log:
                if avail < 0:
                    (fragment, _) = utils.last_bytes(log, avail + size)
                    remainder = fragment.find('\n') + 1
                    console_str = fragment[remainder:] + console_str
                    break
                fragment = ''
                for line in log.readlines():
                    fragment += line
                console_str = fragment + console_str
        return console_str

    def get_console_output(self, context, instance):
        """Get console output for an instance

        :param context: security context
        :param instance: nova.objects.instance.Instance
        """
        return self._get_console_output(instance)

    def get_vnc_console(self, context, instance):
        """Get connection info for a vnc console.

        :param context: security context
        :param instance: nova.objects.instance.Instance

        :returns an instance of console.type.ConsoleVNC
        """
        # Do not provide console access prematurely. Zone console access is
        # exclusive and zones that are still installing require their console.
        # Grabbing the zone console will break installation.
        name = instance['name']
        if instance['vm_state'] == vm_states.BUILDING:
            LOG.info(_("VNC console not available until zone '%s' has "
                     "completed installation. Try again later.") % name)
            raise exception.InstanceNotReady(instance_id=instance['uuid'])

        if not self._has_vnc_console_service(instance):
            LOG.debug(_("Creating zone VNC console SMF service for "
                      "instance '%s'") % name)
            self._create_vnc_console_service(instance)

        self._enable_vnc_console_service(instance)
        console_fmri = VNC_CONSOLE_BASE_FMRI + ':' + name

        # The console service sets an SMF instance property for the port
        # on which the VNC service is listening. The service needs to be
        # refreshed to reflect the current property value
        # TODO(npower): investigate using RAD instead of CLI invocation
        try:
            out, err = utils.execute('/usr/sbin/svccfg', '-s', console_fmri,
                                     'refresh')
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Unable to refresh zone VNC console SMF service "
                            "'%s': %s" % (console_fmri, reason)))
            raise

        host = CONF.vnc.vncserver_proxyclient_address
        try:
            out, err = utils.execute('/usr/bin/svcprop', '-p', 'vnc/port',
                                     console_fmri)
            port = int(out.strip())
            return ctype.ConsoleVNC(host=host, port=port,
                                    internal_access_path=None)
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Unable to read VNC console port from zone VNC "
                            "console SMF service '%s': %s"
                          % (console_fmri, reason)))

    def get_spice_console(self, context, instance):
        """Get connection info for a spice console.

        :param context: security context
        :param instance: nova.objects.instance.Instance

        :returns an instance of console.type.ConsoleSpice
        """
        raise NotImplementedError()

    def get_rdp_console(self, context, instance):
        """Get connection info for a rdp console.

        :param context: security context
        :param instance: nova.objects.instance.Instance

        :returns an instance of console.type.ConsoleRDP
        """
        raise NotImplementedError()

    def get_serial_console(self, context, instance):
        """Get connection info for a serial console.

        :param context: security context
        :param instance: nova.objects.instance.Instance

        :returns an instance of console.type.ConsoleSerial
        """
        raise NotImplementedError()

    def get_mks_console(self, context, instance):
        """Get connection info for a MKS console.

        :param context: security context
        :param instance: nova.objects.instance.Instance

        :returns an instance of console.type.ConsoleMKS
        """
        raise NotImplementedError()

    def _get_zone_diagnostics(self, zone):
        """Return data about Solaris Zone diagnostics."""
        if zone.id == -1:
            return None

        diagnostics = defaultdict(lambda: 0)

        for stat in ['lockedmem', 'nprocs', 'swapresv']:
            uri = "kstat:/zone_caps/caps/%s_zone_%d/%d" % (stat, zone.id,
                                                           zone.id)
            diagnostics[stat] = self._kstat_data(uri)['usage']

        # Get the inital accumulated data kstat, then get the sys_zone kstat
        # and sum all the "*_cur" statistics in it. Then re-get the accumulated
        # kstat, and if the generation number hasn't changed, add its values.
        # If it has changed, try again a few times then give up because
        # something keeps pulling cpus out from under us.

        accum_uri = "kstat:/zones/cpu/sys_zone_accum/%d" % zone.id
        uri = "kstat:/zones/cpu/sys_zone_%d" % zone.id

        for _attempt in range(3):
            initial = self._kstat_data(accum_uri)
            data = self._kstat_data(uri)
            # The list of cpu kstats in data must contain at least one element
            # and all elements have the same map of statistics, since they're
            # all the same kstat type. This gets a list of all the statistics
            # which end in "_cur" from the first (guaranteed) kstat element.
            stats = [k for k in data[data.keys()[0]].getMap().keys() if
                     k.endswith("_cur")]

            for stat in stats:
                diagnostics[stat[:-4]] += self._sum_kstat_statistic(data, stat)

            final = self._kstat_data(accum_uri)

            if initial['gen_num'] == final['gen_num']:
                for stat in stats:
                    # Remove the '_cur' from the statistic
                    diagnostics[stat[:-4]] += initial[stat[:-4]]
                break
        else:
            reason = (_("Could not get diagnostic info for instance '%s' "
                        "because the cpu list keeps changing.") % zone.name)
            raise nova.exception.MaxRetriesExceeded(reason)

        # Remove any None valued elements from diagnostics and return it
        return {k: v for k, v in diagnostics.items() if v is not None}

    def get_diagnostics(self, instance):
        """Return diagnostics data about the given instance.

        :param nova.objects.instance.Instance instance:
            The instance to which the diagnostic data should be returned.

        :return: Has a big overlap to the return value of the newer interface
            :func:`get_instance_diagnostics`
        :rtype: dict
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)
        return self._get_zone_diagnostics(zone)

    def get_instance_diagnostics(self, instance):
        """Return diagnostics data about the given instance.

        :param nova.objects.instance.Instance instance:
            The instance to which the diagnostic data should be returned.

        :return: Has a big overlap to the return value of the older interface
            :func:`get_diagnostics`
        :rtype: nova.virt.diagnostics.Diagnostics
        """
        raise NotImplementedError()

    def get_all_bw_counters(self, instances):
        """Return bandwidth usage counters for each interface on each
           running VM.

        :param instances: nova.objects.instance.InstanceList
        """
        raise NotImplementedError()

    def get_all_volume_usage(self, context, compute_host_bdms):
        """Return usage info for volumes attached to vms on
           a given host.-
        """
        raise NotImplementedError()

    def get_host_ip_addr(self):
        """Retrieves the IP address of the dom0
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        return CONF.my_ip

    def attach_volume(self, context, connection_info, instance, mountpoint,
                      disk_bus=None, device_type=None, encryption=None):
        """Attach the disk to the instance at mountpoint using info."""
        # TODO(npower): Apply mountpoint in a meaningful way to the zone
        # For security reasons this is not permitted in a Solaris branded zone.
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        if brand != ZONE_BRAND_SOLARIS_KZ:
            # Only Solaris kernel zones are currently supported.
            reason = (_("'%s' branded zones are not currently supported")
                      % brand)
            raise NotImplementedError(reason)

        suri = self._suri_from_volume_info(connection_info)

        resource_scope = [zonemgr.Property("storage", suri)]
        if connection_info.get('serial') is not None:
            volume = self._volume_api.get(context, connection_info['serial'])
            if volume['bootable']:
                resource_scope.append(zonemgr.Property("bootpri", "1"))

        with ZoneConfig(zone) as zc:
            zc.addresource("device", resource_scope)

        # apply the configuration to the running zone
        if zone.state == ZONE_STATE_RUNNING:
            try:
                zone.apply()
            except Exception as ex:
                reason = zonemgr_strerror(ex)
                LOG.exception(_("Unable to attach '%s' to instance '%s' via "
                                "zonemgr(3RAD): %s") % (suri, name, reason))
                with ZoneConfig(zone) as zc:
                    zc.removeresources("device", resource_scope)
                raise

    def detach_volume(self, connection_info, instance, mountpoint,
                      encryption=None):
        """Detach the disk attached to the instance."""
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        if brand != ZONE_BRAND_SOLARIS_KZ:
            # Only Solaris kernel zones are currently supported.
            reason = (_("'%s' branded zones are not currently supported")
                      % brand)
            raise NotImplementedError(reason)

        suri = self._suri_from_volume_info(connection_info)

        # Check if the specific property value exists before attempting removal
        resource = lookup_resource_property_value(zone, "device", "storage",
                                                  suri)
        if not resource:
            LOG.warning(_("Storage resource '%s' is not attached to instance "
                        "'%s'") % (suri, name))
            return

        with ZoneConfig(zone) as zc:
            zc.removeresources("device", [zonemgr.Property("storage", suri)])

        # apply the configuration to the running zone
        if zone.state == ZONE_STATE_RUNNING:
            try:
                zone.apply()
            except:
                LOG.exception(_("Unable to apply the detach of resource '%s' "
                                "to running instance '%s' because the "
                                "resource is most likely in use.")
                              % (suri, name))

                # re-add the entry to the zone configuration so that the
                # configuration will reflect what is in cinder before we raise
                # the exception, therefore failing the detach and leaving the
                # volume in-use.
                needed_props = ["storage", "bootpri"]
                props = filter(lambda prop: prop.name in needed_props,
                               resource.properties)
                with ZoneConfig(zone) as zc:
                    zc.addresource("device", props)

                raise

    def swap_volume(self, old_connection_info, new_connection_info,
                    instance, mountpoint, resize_to):
        """Replace the volume attached to the given `instance`.

        :param dict old_connection_info:
            The volume for this connection gets detached from the given
            `instance`.
        :param dict new_connection_info:
            The volume for this connection gets attached to the given
            'instance'.
        :param nova.objects.instance.Instance instance:
            The instance whose volume gets replaced by another one.
        :param str mountpoint:
            The mountpoint in the instance where the volume for
            `old_connection_info` is attached to.
        :param int resize_to:
            If the new volume is larger than the old volume, it gets resized
            to the given size (in Gigabyte) of `resize_to`.

        :return: None
        """
        raise NotImplementedError()

    def attach_interface(self, instance, image_meta, vif):
        """Use hotplug to add a network interface to a running instance.

        The counter action to this is :func:`detach_interface`.

        :param nova.objects.instance.Instance instance:
            The instance which will get an additional network interface.
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        :param nova.network.model.NetworkInfo vif:
            The object which has the information about the interface to attach.

        :raise nova.exception.NovaException: If the attach fails.

        :return: None
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        ctxt = nova_context.get_admin_context()
        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        anetname = self._set_ovs_info(ctxt, zone, brand, False, vif)

        # apply the configuration if the vm is ACTIVE
        if instance['vm_state'] == vm_states.ACTIVE:
            try:
                zone.apply()
            except Exception as ex:
                reason = zonemgr_strerror(ex)
                msg = (_("Unable to attach interface to instance '%s' via "
                         "zonemgr(3RAD): %s") % (name, reason))
                with ZoneConfig(zone) as zc:
                    prop_filter = [zonemgr.Property('mac-address',
                                                    vif['address'])]
                    zc.removeresources('anet', prop_filter)
                raise nova.exception.NovaException(msg)

            # add port to ovs bridge
            anet = ''.join([name, '/', anetname])
            self._ovs_add_port(instance, vif, anet)

    def detach_interface(self, instance, vif):
        """Use hotunplug to remove a network interface from a running instance.

        The counter action to this is :func:`attach_interface`.

        :param nova.objects.instance.Instance instance:
            The instance which gets a network interface removed.
        :param nova.network.model.NetworkInfo vif:
            The object which has the information about the interface to detach.

        :raise nova.exception.NovaException: If the detach fails.

        :return: None
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # Check if the specific property value exists before attempting removal
        resource = lookup_resource_property_value(zone, 'anet',
                                                  'mac-address',
                                                  vif['address'])
        if not resource:
            msg = (_("Interface with MAC address '%s' is not attached to "
                     "instance '%s'.") % (vif['address'], name))
            raise nova.exception.NovaException(msg)

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        for prop in resource.properties:
            if brand == ZONE_BRAND_SOLARIS and prop.name == 'linkname':
                anetname = prop.value
                break
            elif brand != ZONE_BRAND_SOLARIS and prop.name == 'id':
                anetname = 'net%s' % prop.value
                break

        with ZoneConfig(zone) as zc:
            zc.removeresources('anet', [zonemgr.Property('mac-address',
                                                         vif['address'])])

        # apply the configuration if the vm is ACTIVE
        if instance['vm_state'] == vm_states.ACTIVE:
            try:
                zone.apply()
            except:
                msg = (_("Unable to detach interface '%s' from running "
                         "instance '%s' because the resource is most likely "
                         "in use.") % (anetname, name))
                needed_props = ["lower-link", "configure-allowed-address",
                                "mac-address", "mtu"]
                if brand == ZONE_BRAND_SOLARIS:
                    needed_props.append("linkname")
                else:
                    needed_props.append("id")

                props = filter(lambda prop: prop.name in needed_props,
                               resource.properties)
                with ZoneConfig(zone) as zc:
                    zc.addresource('anet', props)
                raise nova.exception.NovaException(msg)

            # remove anet from OVS bridge
            port = ''.join([name, '/', anetname])
            self._ovs_delete_port(port)

    def _cleanup_migrate_disk(self, context, instance, volume):
        """Make a best effort at cleaning up the volume that was created to
        hold the new root disk

        :param context: the context for the migration/resize
        :param instance: nova.objects.instance.Instance being migrated/resized
        :param volume: new volume created by the call to cinder create
        """
        try:
            self._volume_api.delete(context, volume['id'])
        except Exception as err:
            LOG.exception(_("Unable to cleanup the resized volume: %s" % err))

    def migrate_disk_and_power_off(self, context, instance, dest,
                                   flavor, network_info,
                                   block_device_info=None,
                                   timeout=0, retry_interval=0):
        """Transfers the disk of a running instance in multiple phases, turning
        off the instance before the end.

        :param nova.objects.instance.Instance instance:
            The instance whose disk should be migrated.
        :param str dest:
            The IP address of the destination host.
        :param nova.objects.flavor.Flavor flavor:
            The flavor of the instance whose disk get migrated.
        :param nova.network.model.NetworkInfo network_info:
            The network information of the given `instance`.
        :param dict block_device_info:
            Information about the block devices.
        :param int timeout:
            The time in seconds to wait for the guest OS to shutdown.
        :param int retry_interval:
            How often to signal guest while waiting for it to shutdown.

        :return: A list of disk information dicts in JSON format.
        :rtype: str
        """
        LOG.debug("Starting migrate_disk_and_power_off", instance=instance)

        samehost = (dest == self.get_host_ip_addr())
        if samehost:
            instance.system_metadata['resize_samehost'] = samehost

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        if brand != ZONE_BRAND_SOLARIS_KZ and not samehost:
            reason = (_("'%s' branded zones do not currently support resize "
                        "to a different host.") % brand)
            raise exception.MigrationPreCheckError(reason=reason)

        if brand != flavor['extra_specs'].get('zonecfg:brand'):
            reason = (_("Unable to change brand of zone during resize."))
            raise exception.MigrationPreCheckError(reason=reason)

        orgb = instance['root_gb']
        nrgb = flavor.root_gb
        if orgb > nrgb:
            msg = (_("Unable to resize to a smaller boot volume."))
            raise exception.ResizeError(reason=msg)

        self.power_off(instance, timeout, retry_interval)

        disk_info = None
        if nrgb > orgb or not samehost:
            bmap = block_device_info.get('block_device_mapping')
            rootmp = instance.root_device_name
            for entry in bmap:
                mountdev = entry['mount_device'].rpartition('/')[2]
                if mountdev == rootmp:
                    root_ci = entry['connection_info']
                    break
            else:
                # If this is a non-global zone that is on the same host and is
                # simply using a dataset, the disk size is purely an OpenStack
                # quota.  We can continue without doing any disk work.
                if samehost and brand == ZONE_BRAND_SOLARIS:
                    return disk_info
                else:
                    msg = (_("Cannot find an attached root device."))
                    raise exception.ResizeError(reason=msg)

            if root_ci['driver_volume_type'] == 'iscsi':
                volume_id = root_ci['data']['volume_id']
            else:
                volume_id = root_ci['serial']

            if volume_id is None:
                msg = (_("Cannot find an attached root device."))
                raise exception.ResizeError(reason=msg)

            vinfo = self._volume_api.get(context, volume_id)
            newvolume = self._volume_api.create(
                context, orgb, vinfo['display_name'] + '-resized',
                vinfo['display_description'], source_volume=vinfo)

            instance.system_metadata['old_instance_volid'] = volume_id
            instance.system_metadata['new_instance_volid'] = newvolume['id']

            # TODO(npower): Polling is what nova/compute/manager also does when
            # creating a new volume, so we do likewise here.
            while True:
                volume = self._volume_api.get(context, newvolume['id'])
                if volume['status'] != 'creating':
                    break
                greenthread.sleep(1)

            if nrgb > orgb:
                try:
                    self._volume_api.extend(context, newvolume['id'], nrgb)
                except Exception:
                    LOG.exception(_("Failed to extend the new volume"))
                    self._cleanup_migrate_disk(context, instance, newvolume)
                    raise

            disk_info = newvolume

        return disk_info

    def snapshot(self, context, instance, image_id, update_task_state):
        """Snapshots the specified instance.

        :param context: security context
        :param instance: nova.objects.instance.Instance
        :param image_id: Reference to a pre-created image that will
                         hold the snapshot.
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # look to see if the zone is a kernel zone and is powered off.  If it
        # is raise an exception before trying to archive it
        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        if zone.state != ZONE_STATE_RUNNING and \
                brand == ZONE_BRAND_SOLARIS_KZ:
            raise exception.InstanceNotRunning(instance_id=name)

        # Get original base image info
        (base_service, base_id) = glance.get_remote_image_service(
            context, instance['image_ref'])
        try:
            base = base_service.show(context, base_id)
        except exception.ImageNotFound:
            base = {}

        snapshot_service, snapshot_id = glance.get_remote_image_service(
            context, image_id)

        # Build updated snapshot image metadata
        snapshot = snapshot_service.show(context, snapshot_id)
        metadata = {
            'is_public': False,
            'status': 'active',
            'name': snapshot['name'],
            'properties': {
                'image_location': 'snapshot',
                'image_state': 'available',
                'owner_id': instance['project_id'],
                'instance_uuid': instance['uuid'],
                'image_type': snapshot['properties']['image_type'],
            }
        }
        # Match architecture, hypervisor_type and vm_mode properties to base
        # image.
        for prop in ['architecture', 'hypervisor_type', 'vm_mode']:
            if prop in base.get('properties', {}):
                base_prop = base['properties'][prop]
                metadata['properties'][prop] = base_prop

        # Set generic container and disk formats initially in case the glance
        # service rejects Unified Archives (uar) and ZFS in metadata.
        metadata['container_format'] = 'ovf'
        metadata['disk_format'] = 'raw'

        update_task_state(task_state=task_states.IMAGE_PENDING_UPLOAD)
        snapshot_directory = CONF.solariszones.solariszones_snapshots_directory
        fileutils.ensure_tree(snapshot_directory)
        snapshot_name = uuid.uuid4().hex

        with utils.tempdir(dir=snapshot_directory) as tmpdir:
            out_path = os.path.join(tmpdir, snapshot_name)
            zone_name = instance['name']
            utils.execute('/usr/sbin/archiveadm', 'create', '--root-only',
                          '-z', zone_name, out_path)

            LOG.info(_("Snapshot extracted, beginning image upload"),
                     instance=instance)
            try:
                # Upload the archive image to the image service
                update_task_state(
                    task_state=task_states.IMAGE_UPLOADING,
                    expected_state=task_states.IMAGE_PENDING_UPLOAD)
                with open(out_path, 'r') as image_file:
                    snapshot_service.update(context, image_id, metadata,
                                            image_file)
                    LOG.info(_("Snapshot image upload complete"),
                             instance=instance)
                try:
                    # Try to update the image metadata container and disk
                    # formats more suitably for a unified archive if the
                    # glance server recognises them.
                    metadata['container_format'] = 'uar'
                    metadata['disk_format'] = 'zfs'
                    snapshot_service.update(context, image_id, metadata, None)
                except exception.Invalid:
                    LOG.warning(_("Image service rejected image metadata "
                                  "container and disk formats 'uar' and "
                                  "'zfs'. Using generic values 'ovf' and "
                                  "'raw' as fallbacks."))
            finally:
                # Delete the snapshot image file source
                os.unlink(out_path)

    def post_interrupted_snapshot_cleanup(self, context, instance):
        """Cleans up any resources left after an interrupted snapshot.

        :param context: security context
        :param instance: nova.objects.instance.Instance
        """
        pass

    def _cleanup_finish_migration(self, context, instance, disk_info,
                                  network_info, samehost):
        """Best effort attempt at cleaning up any additional resources that are
        not directly managed by Nova or Cinder so as not to leak these
        resources.
        """
        if disk_info:
            self._volume_api.detach(context, disk_info['id'])
            self._volume_api.delete(context, disk_info['id'])

            old_rvid = instance.system_metadata.get('old_instance_volid')
            if old_rvid:
                connector = self.get_volume_connector(instance)
                connection_info = self._volume_api.initialize_connection(
                    context, old_rvid, connector)

                new_rvid = instance.system_metadata['new_instance_volid']

                rootmp = instance.root_device_name
                self._volume_api.attach(context, old_rvid, instance['uuid'],
                                        rootmp)

                bdmobj = objects.BlockDeviceMapping()
                bdm = bdmobj.get_by_volume_id(context, new_rvid)
                bdm['connection_info'] = jsonutils.dumps(connection_info)
                bdm['volume_id'] = old_rvid
                bdm.save()

                del instance.system_metadata['new_instance_volid']
                del instance.system_metadata['old_instance_volid']

        if not samehost:
            self.destroy(context, instance, network_info)
            instance['host'] = instance['launched_on']
            instance['node'] = instance['launched_on']

    def finish_migration(self, context, migration, instance, disk_info,
                         network_info, image_meta, resize_instance,
                         block_device_info=None, power_on=True):
        """Completes a resize/migration.

        :param context: the context for the migration/resize
        :param migration: the migrate/resize information
        :param instance: nova.objects.instance.Instance being migrated/resized
        :param disk_info: the newly transferred disk information
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        :param resize_instance: True if the instance is being resized,
                                False otherwise
        :param block_device_info: instance volume block device info
        :param power_on: True if the instance should be powered on, False
                         otherwise
        """
        samehost = (migration['dest_node'] == migration['source_node'])
        if samehost:
            instance.system_metadata['old_vm_state'] = vm_states.RESIZED

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        name = instance['name']

        if disk_info:
            bmap = block_device_info.get('block_device_mapping')
            rootmp = instance['root_device_name']
            for entry in bmap:
                if entry['mount_device'] == rootmp:
                    mount_dev = entry['mount_device']
                    root_ci = entry['connection_info']
                    break

        try:
            if samehost:
                cpu = instance.vcpus
                mem = instance.memory_mb
                self._set_num_cpu(name, cpu, brand)
                self._set_memory_cap(name, mem, brand)

                # Add the new disk to the volume if the size of the disk
                # changed
                if disk_info:
                    rgb = instance.root_gb
                    self._resize_disk_migration(context, instance,
                                                root_ci['serial'],
                                                disk_info['id'], rgb,
                                                mount_dev)

            else:
                # No need to check disk_info here, because when not on the
                # same host a disk_info is always passed in.
                mount_dev = 'c1d0'
                root_serial = root_ci['serial']
                connection_info = self._resize_disk_migration(context,
                                                              instance,
                                                              root_serial,
                                                              disk_info['id'],
                                                              0, mount_dev,
                                                              samehost)

                self._create_config(context, instance, network_info,
                                    connection_info, None)

                zone = self._get_zone_by_name(name)
                if zone is None:
                    raise exception.InstanceNotFound(instance_id=name)

                zone.attach(['-x', 'initialize-hostdata'])

                bmap = block_device_info.get('block_device_mapping')
                for entry in bmap:
                    if entry['mount_device'] != rootmp:
                        self.attach_volume(context, entry['connection_info'],
                                           instance, entry['mount_device'])

            if power_on:
                self._power_on(instance, network_info)

                if brand == ZONE_BRAND_SOLARIS:
                    return

                # Toggle the autoexpand to extend the size of the rpool.
                # We need to sleep for a few seconds to make sure the zone
                # is in a state to accept the toggle.  Once bugs are fixed
                # around the autoexpand and the toggle is no longer needed
                # or zone.boot() returns only after the zone is ready we
                # can remove this hack.
                greenthread.sleep(15)
                out, err = utils.execute('/usr/sbin/zlogin', '-S', name,
                                         '/usr/sbin/zpool', 'set',
                                         'autoexpand=off', 'rpool')
                out, err = utils.execute('/usr/sbin/zlogin', '-S', name,
                                         '/usr/sbin/zpool', 'set',
                                         'autoexpand=on', 'rpool')
        except Exception:
            # Attempt to cleanup the new zone and new volume to at least
            # give the user a chance to recover without too many hoops
            self._cleanup_finish_migration(context, instance, disk_info,
                                           network_info, samehost)
            raise

    def confirm_migration(self, context, migration, instance, network_info):
        """Confirms a resize/migration, destroying the source VM.

        :param instance: nova.objects.instance.Instance
        """
        samehost = (migration['dest_host'] == self.get_host_ip_addr())
        old_rvid = instance.system_metadata.get('old_instance_volid')
        new_rvid = instance.system_metadata.get('new_instance_volid')
        if new_rvid and old_rvid:
            new_vname = instance['display_name'] + "-" + self._rootzpool_suffix
            del instance.system_metadata['old_instance_volid']
            del instance.system_metadata['new_instance_volid']

            self._volume_api.delete(context, old_rvid)
            self._volume_api.update(context, new_rvid,
                                    {'display_name': new_vname})

        if not samehost:
            self.destroy(context, instance, network_info)
        else:
            del instance.system_metadata['resize_samehost']

    def _resize_disk_migration(self, context, instance, configured,
                               replacement, newvolumesz, mountdev,
                               samehost=True):
        """Handles the zone root volume switch-over or simply
        initializing the connection for the new zone if not resizing to the
        same host

        :param context: the context for the _resize_disk_migration
        :param instance: nova.objects.instance.Instance being resized
        :param configured: id of the current configured volume
        :param replacement: id of the new volume
        :param newvolumesz: size of the new volume
        :param mountdev: the mount point of the device
        :param samehost: is the resize happening on the same host
        """
        connector = self.get_volume_connector(instance)
        connection_info = self._volume_api.initialize_connection(context,
                                                                 replacement,
                                                                 connector)
        connection_info['serial'] = replacement
        rootmp = instance.root_device_name

        if samehost:
            name = instance['name']
            zone = self._get_zone_by_name(name)
            if zone is None:
                raise exception.InstanceNotFound(instance_id=name)

            # Need to detach the zone and re-attach the zone if this is a
            # non-global zone so that the update of the rootzpool resource does
            # not fail.
            if zone.brand == ZONE_BRAND_SOLARIS:
                zone.detach()

            try:
                self._set_boot_device(name, connection_info, zone.brand)
            finally:
                if zone.brand == ZONE_BRAND_SOLARIS:
                    zone.attach()

        try:
            self._volume_api.detach(context, configured)
        except Exception:
            LOG.exception(_("Failed to detach the volume"))
            raise

        try:
            self._volume_api.attach(context, replacement, instance['uuid'],
                                    rootmp)
        except Exception:
            LOG.exception(_("Failed to attach the volume"))
            raise

        bdmobj = objects.BlockDeviceMapping()
        bdm = bdmobj.get_by_volume_id(context, configured)
        bdm['connection_info'] = jsonutils.dumps(connection_info)
        bdm['volume_id'] = replacement
        bdm.save()

        if not samehost:
            return connection_info

    def finish_revert_migration(self, context, instance, network_info,
                                block_device_info=None, power_on=True):
        """Finish reverting a resize/migration.

        :param context: the context for the finish_revert_migration
        :param instance: nova.objects.instance.Instance being migrated/resized
        :param network_info:
           :py:meth:`~nova.network.manager.NetworkManager.get_instance_nw_info`
        :param block_device_info: instance volume block device info
        :param power_on: True if the instance should be powered on, False
                         otherwise
        """
        # If this is not a samehost migration then we need to re-attach the
        # original volume to the instance. Otherwise we need to update the
        # original zone configuration.
        samehost = instance.system_metadata.get('resize_samehost')
        if samehost:
            self._samehost_revert_resize(context, instance, network_info,
                                         block_device_info)
            del instance.system_metadata['resize_samehost']

        old_rvid = instance.system_metadata.get('old_instance_volid')
        if old_rvid:
            connector = self.get_volume_connector(instance)
            connection_info = self._volume_api.initialize_connection(context,
                                                                     old_rvid,
                                                                     connector)

            new_rvid = instance.system_metadata['new_instance_volid']
            self._volume_api.detach(context, new_rvid)
            self._volume_api.delete(context, new_rvid)

            rootmp = instance.root_device_name
            self._volume_api.attach(context, old_rvid, instance['uuid'],
                                    rootmp)

            bdmobj = objects.BlockDeviceMapping()
            bdm = bdmobj.get_by_volume_id(context, new_rvid)
            bdm['connection_info'] = jsonutils.dumps(connection_info)
            bdm['volume_id'] = old_rvid
            bdm.save()

            del instance.system_metadata['new_instance_volid']
            del instance.system_metadata['old_instance_volid']
        else:
            new_rvid = instance.system_metadata.get('new_instance_volid')
            if new_rvid:
                del instance.system_metadata['new_instance_volid']
                self._volume_api.delete(context, new_rvid)

        self._power_on(instance, network_info)

    def pause(self, instance):
        """Pause the given instance.

        A paused instance doesn't use CPU cycles of the host anymore. The
        state of the VM could be stored in the memory or storage space of the
        host, depending on the underlying hypervisor technology.
        A "stronger" version of `pause` is :func:'suspend'.
        The counter action for `pause` is :func:`unpause`.

        :param nova.objects.instance.Instance instance:
            The instance which should be paused.

        :return: None
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def unpause(self, instance):
        """Unpause the given paused instance.

        The paused instance gets unpaused and will use CPU cycles of the
        host again. The counter action for 'unpause' is :func:`pause`.
        Depending on the underlying hypervisor technology, the guest has the
        same state as before the 'pause'.

        :param nova.objects.instance.Instance instance:
            The instance which should be unpaused.

        :return: None
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def suspend(self, context, instance):
        """Suspend the specified instance.

        A suspended instance doesn't use CPU cycles or memory of the host
        anymore. The state of the instance could be persisted on the host
        and allocate storage space this way. A "softer" way of `suspend`
        is :func:`pause`. The counter action for `suspend` is :func:`resume`.

        :param nova.context.RequestContext context:
            The context for the suspend.
        :param nova.objects.instance.Instance instance:
            The instance to suspend.

        :return: None
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if zone.brand != ZONE_BRAND_SOLARIS_KZ:
            # Only Solaris kernel zones are currently supported.
            reason = (_("'%s' branded zones do not currently support "
                        "suspend. Use 'nova reset-state --active %s' "
                        "to reset instance state back to 'active'.")
                      % (zone.brand, instance['display_name']))
            raise exception.InstanceSuspendFailure(reason=reason)

        if self._get_state(zone) != power_state.RUNNING:
            reason = (_("Instance '%s' is not running.") % name)
            raise exception.InstanceSuspendFailure(reason=reason)

        try:
            new_path = os.path.join(CONF.solariszones.zones_suspend_path,
                                    '%{zonename}')
            if not lookup_resource(zone, 'suspend'):
                # add suspend if not configured
                self._set_suspend(instance)
            elif lookup_resource_property(zone, 'suspend', 'path') != new_path:
                # replace the old suspend resource with the new one
                with ZoneConfig(zone) as zc:
                    zc.removeresources('suspend')
                self._set_suspend(instance)

            zone.suspend()
            self._unplug_vifs(instance)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to suspend instance '%s' via "
                            "zonemgr(3RAD): %s") % (name, reason))
            raise exception.InstanceSuspendFailure(reason=reason)

    def resume(self, context, instance, network_info, block_device_info=None):
        """resume the specified suspended instance.

        The suspended instance gets resumed and will use CPU cycles and memory
        of the host again. The counter action for 'resume' is :func:`suspend`.
        Depending on the underlying hypervisor technology, the guest has the
        same state as before the 'suspend'.

        :param nova.context.RequestContext context:
            The context for the resume.
        :param nova.objects.instance.Instance instance:
            The suspended instance to resume.
        :param nova.network.model.NetworkInfo network_info:
            Necessary network information for the resume.
        :param dict block_device_info:
            Instance volume block device info.

        :return: None
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if zone.brand != ZONE_BRAND_SOLARIS_KZ:
            # Only Solaris kernel zones are currently supported.
            reason = (_("'%s' branded zones do not currently support "
                      "resume.") % zone.brand)
            raise exception.InstanceResumeFailure(reason=reason)

        # check that the instance is suspended
        if self._get_state(zone) != power_state.SHUTDOWN:
            reason = (_("Instance '%s' is not suspended.") % name)
            raise exception.InstanceResumeFailure(reason=reason)

        try:
            zone.boot()
            self._plug_vifs(instance, network_info)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to resume instance '%s' via "
                            "zonemgr(3RAD): %s") % (name, reason))
            raise exception.InstanceResumeFailure(reason=reason)

    def resume_state_on_host_boot(self, context, instance, network_info,
                                  block_device_info=None):
        """resume guest state when a host is booted.

        :param instance: nova.objects.instance.Instance
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        # TODO(dcomay): Should reconcile with value of zone's autoboot
        # property.
        if self._get_state(zone) not in (power_state.CRASHED,
                                         power_state.SHUTDOWN):
            return

        self._power_on(instance, network_info)

    def rescue(self, context, instance, network_info, image_meta,
               rescue_password):
        """Rescue the specified instance.

        :param nova.context.RequestContext context:
            The context for the rescue.
        :param nova.objects.instance.Instance instance:
            The instance being rescued.
        :param nova.network.model.NetworkInfo network_info:
            Necessary network information for the resume.
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        :param rescue_password: new root password to set for rescue.
        """
        raise NotImplementedError()

    def set_bootable(self, instance, is_bootable):
        """Set the ability to power on/off an instance.

        :param instance: nova.objects.instance.Instance
        """
        raise NotImplementedError()

    def unrescue(self, instance, network_info):
        """Unrescue the specified instance.

        :param instance: nova.objects.instance.Instance
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def power_off(self, instance, timeout=0, retry_interval=0):
        """Power off the specified instance.

        :param instance: nova.objects.instance.Instance
        :param timeout: time to wait for GuestOS to shutdown
        :param retry_interval: How often to signal guest while
                               waiting for it to shutdown
        """
        self._power_off(instance, 'SOFT')

    def power_on(self, context, instance, network_info,
                 block_device_info=None):
        """Power on the specified instance.

        :param instance: nova.objects.instance.Instance
        """
        self._power_on(instance, network_info)

    def trigger_crash_dump(self, instance):
        """Trigger crash dump mechanism on the given instance.

        Stalling instances can be triggered to dump the crash data. How the
        guest OS reacts in details, depends on the configuration of it.

        :param nova.objects.instance.Instance instance:
            The instance where the crash dump should be triggered.

        :return: None
        """
        raise NotImplementedError()

    def soft_delete(self, instance):
        """Soft delete the specified instance.

        A soft-deleted instance doesn't allocate any resources anymore, but is
        still available as a database entry. The counter action :func:`restore`
        uses the database entry to create a new instance based on that.

        :param nova.objects.instance.Instance instance:
            The instance to soft-delete.

        :return: None
        """
        raise NotImplementedError()

    def restore(self, instance):
        """Restore the specified soft-deleted instance.

        The restored instance will be automatically booted. The counter action
        for `restore` is :func:`soft_delete`.

        :param nova.objects.instance.Instance instance:
            The soft-deleted instance which should be restored from the
            soft-deleted data.

        :return: None
        """
        raise NotImplementedError()

    def _get_zpool_property(self, prop, zpool):
        """Get the value of property from the zpool."""
        try:
            value = None
            (out, _err) = utils.execute('/usr/sbin/zpool', 'get', prop, zpool)
        except processutils.ProcessExecutionError as ex:
            reason = ex.stderr
            LOG.exception(_("Failed to get property '%s' from zpool '%s': %s")
                          % (prop, zpool, reason))
            return value

        zpool_prop = out.splitlines()[1].split()
        if zpool_prop[1] == prop:
            value = zpool_prop[2]
        return value

    def _update_host_stats(self):
        """Update currently known host stats."""
        host_stats = {}

        host_stats['vcpus'] = os.sysconf('SC_NPROCESSORS_ONLN')

        pages = os.sysconf('SC_PHYS_PAGES')
        host_stats['memory_mb'] = self._pages_to_kb(pages) / 1024

        out, err = utils.execute('/usr/sbin/zfs', 'list', '-Ho', 'name', '/')
        root_zpool = out.split('/')[0]
        size = self._get_zpool_property('size', root_zpool)
        if size is not None:
            host_stats['local_gb'] = Size(size).get(Size.gb_units)
        else:
            host_stats['local_gb'] = 0

        # Account for any existing processor sets by looking at the the number
        # of CPUs not assigned to any processor sets.
        uri = "kstat:/misc/unix/pset/0"
        data = self._kstat_data(uri)

        if data is not None:
            host_stats['vcpus_used'] = host_stats['vcpus'] - data['ncpus']
        else:
            host_stats['vcpus_used'] = 0

        # Subtract the number of free pages from the total to get the used.
        uri = "kstat:/pages/unix/system_pages"
        data = self._kstat_data(uri)
        if data is not None:
            free_ram = data['freemem']
            free_ram = self._pages_to_kb(free_ram) / 1024
            host_stats['memory_mb_used'] = host_stats['memory_mb'] - free_ram
        else:
            host_stats['memory_mb_used'] = 0

        free = self._get_zpool_property('free', root_zpool)
        if free is not None:
            free_disk_gb = Size(free).get(Size.gb_units)
        else:
            free_disk_gb = 0
        host_stats['local_gb_used'] = host_stats['local_gb'] - free_disk_gb

        host_stats['hypervisor_type'] = 'solariszones'
        host_stats['hypervisor_version'] = \
            versionutils.convert_version_to_int(HYPERVISOR_VERSION)
        host_stats['hypervisor_hostname'] = self._uname[1]

        if self._uname[4] == 'i86pc':
            architecture = arch.X86_64
        else:
            architecture = arch.SPARC64
        cpu_info = {
            'arch': architecture
        }
        host_stats['cpu_info'] = jsonutils.dumps(cpu_info)

        host_stats['disk_available_least'] = free_disk_gb
        host_stats['supported_instances'] = [
            (architecture, hv_type.SOLARISZONES, vm_mode.SOL)
        ]
        host_stats['numa_topology'] = None

        self._host_stats = host_stats

    def get_available_resource(self, nodename):
        """Retrieve resource information.

        This method is called when nova-compute launches, and
        as part of a periodic task that records the results in the DB.

        :param nodename:
            node which the caller want to get resources from
            a driver that manages only one node can safely ignore this
        :returns: Dictionary describing resources
        """
        self._update_host_stats()
        host_stats = self._host_stats

        resources = {}
        resources['vcpus'] = host_stats['vcpus']
        resources['memory_mb'] = host_stats['memory_mb']
        resources['local_gb'] = host_stats['local_gb']
        resources['vcpus_used'] = host_stats['vcpus_used']
        resources['memory_mb_used'] = host_stats['memory_mb_used']
        resources['local_gb_used'] = host_stats['local_gb_used']
        resources['hypervisor_type'] = host_stats['hypervisor_type']
        resources['hypervisor_version'] = host_stats['hypervisor_version']
        resources['hypervisor_hostname'] = host_stats['hypervisor_hostname']
        resources['cpu_info'] = host_stats['cpu_info']
        resources['disk_available_least'] = host_stats['disk_available_least']
        resources['supported_instances'] = host_stats['supported_instances']
        resources['numa_topology'] = host_stats['numa_topology']
        return resources

    def pre_live_migration(self, context, instance, block_device_info,
                           network_info, disk_info, migrate_data=None):
        """Prepare an instance for live migration

        :param context: security context
        :param instance: nova.objects.instance.Instance object
        :param block_device_info: instance block device information
        :param network_info: instance network information
        :param disk_info: instance disk information
        :param migrate_data: a LiveMigrateData object
        """
        return migrate_data

    def _live_migration(self, name, dest, dry_run=False):
        """Live migration of a Solaris kernel zone to another host."""
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        options = []
        live_migration_cipher = CONF.solariszones.live_migration_cipher
        if live_migration_cipher is not None:
            options.extend(['-c', live_migration_cipher])
        if dry_run:
            options.append('-nq')
        options.append('ssh://nova@' + dest)
        zone.migrate(options)

    def live_migration(self, context, instance, dest,
                       post_method, recover_method, block_migration=False,
                       migrate_data=None):
        """Live migration of an instance to another host.

        :param context: security context
        :param instance:
            nova.db.sqlalchemy.models.Instance object
            instance object that is migrated.
        :param dest: destination host
        :param post_method:
            post operation method.
            expected nova.compute.manager._post_live_migration.
        :param recover_method:
            recovery method when any exception occurs.
            expected nova.compute.manager._rollback_live_migration.
        :param block_migration: if true, migrate VM disk.
        :param migrate_data: a LiveMigrateData object

        """
        name = instance['name']
        try:
            self._live_migration(name, dest, dry_run=False)
        except Exception as ex:
            with excutils.save_and_reraise_exception():
                reason = zonemgr_strerror(ex)
                LOG.exception(_("Unable to live migrate instance '%s' to host "
                                "'%s' via zonemgr(3RAD): %s")
                              % (name, dest, reason))
                recover_method(context, instance, dest, block_migration)

        post_method(context, instance, dest, block_migration, migrate_data)

    def live_migration_force_complete(self, instance):
        """Force live migration to complete

        :param instance: Instance being live migrated

        """
        raise NotImplementedError()

    def live_migration_abort(self, instance):
        """Abort an in-progress live migration.

        :param instance: instance that is live migrating

        """
        raise NotImplementedError()

    def rollback_live_migration_at_destination(self, context, instance,
                                               network_info,
                                               block_device_info,
                                               destroy_disks=True,
                                               migrate_data=None):
        """Clean up destination node after a failed live migration.

        :param context: security context
        :param instance: instance object that was being migrated
        :param network_info: instance network information
        :param block_device_info: instance block device information
        :param destroy_disks:
            if true, destroy disks at destination during cleanup
        :param migrate_data: a LiveMigrateData object

        """
        pass

    def post_live_migration(self, context, instance, block_device_info,
                            migrate_data=None):
        """Post operation of live migration at source host.

        :param context: security context
        :instance: instance object that was migrated
        :block_device_info: instance block device information
        :param migrate_data: a LiveMigrateData object
        """
        try:
            # These methods log if problems occur so no need to double log
            # here. Just catch any stray exceptions and allow destroy to
            # proceed.
            if self._has_vnc_console_service(instance):
                self._disable_vnc_console_service(instance)
                self._delete_vnc_console_service(instance)
        except Exception:
            pass

        name = instance['name']
        zone = self._get_zone_by_name(name)
        # If instance cannot be found, just return.
        if zone is None:
            LOG.warning(_("Unable to find instance '%s' via zonemgr(3RAD)")
                        % name)
            return

        try:
            self._delete_config(instance)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            LOG.exception(_("Unable to delete configuration for instance '%s' "
                            "via zonemgr(3RAD): %s") % (name, reason))
            raise

    def post_live_migration_at_source(self, context, instance, network_info):
        """Unplug VIFs from networks at source.

        :param context: security context
        :param instance: instance object reference
        :param network_info: instance network information
        """
        self._unplug_vifs(instance)

    def post_live_migration_at_destination(self, context, instance,
                                           network_info,
                                           block_migration=False,
                                           block_device_info=None):
        """Post operation of live migration at destination host.

        :param context: security context
        :param instance: instance object that is migrated
        :param network_info: instance network information
        :param block_migration: if true, post operation of block_migration.
        """
        self._plug_vifs(instance, network_info)

    def check_instance_shared_storage_local(self, context, instance):
        """Check if instance files located on shared storage.

        This runs check on the destination host, and then calls
        back to the source host to check the results.

        :param context: security context
        :param instance: nova.objects.instance.Instance object
        """
        raise NotImplementedError()

    def check_instance_shared_storage_remote(self, context, data):
        """Check if instance files located on shared storage.

        :param context: security context
        :param data: result of check_instance_shared_storage_local
        """
        raise NotImplementedError()

    def check_instance_shared_storage_cleanup(self, context, data):
        """Do cleanup on host after check_instance_shared_storage calls

        :param context: security context
        :param data: result of check_instance_shared_storage_local
        """
        pass

    def check_can_live_migrate_destination(self, context, instance,
                                           src_compute_info, dst_compute_info,
                                           block_migration=False,
                                           disk_over_commit=False):
        """Check if it is possible to execute live migration.

        This runs checks on the destination host, and then calls
        back to the source host to check the results.

        :param context: security context
        :param instance: nova.db.sqlalchemy.models.Instance
        :param src_compute_info: Info about the sending machine
        :param dst_compute_info: Info about the receiving machine
        :param block_migration: if true, prepare for block migration
        :param disk_over_commit: if true, allow disk over commit
        :returns: a LiveMigrateData object (hypervisor-dependent)
        """
        src_cpu_info = jsonutils.loads(src_compute_info['cpu_info'])
        src_cpu_arch = src_cpu_info['arch']
        dst_cpu_info = jsonutils.loads(dst_compute_info['cpu_info'])
        dst_cpu_arch = dst_cpu_info['arch']
        if src_cpu_arch != dst_cpu_arch:
            reason = (_("CPU architectures between source host '%s' (%s) and "
                        "destination host '%s' (%s) are incompatible.")
                      % (src_compute_info['hypervisor_hostname'], src_cpu_arch,
                         dst_compute_info['hypervisor_hostname'],
                         dst_cpu_arch))
            raise exception.MigrationPreCheckError(reason=reason)

        extra_specs = self._get_flavor(instance)['extra_specs'].copy()
        brand = extra_specs.get('zonecfg:brand', ZONE_BRAND_SOLARIS)
        if brand != ZONE_BRAND_SOLARIS_KZ:
            # Only Solaris kernel zones are currently supported.
            reason = (_("'%s' branded zones do not currently support live "
                        "migration.") % brand)
            raise exception.MigrationPreCheckError(reason=reason)

        if block_migration:
            reason = (_('Block migration is not currently supported.'))
            raise exception.MigrationPreCheckError(reason=reason)
        if disk_over_commit:
            reason = (_('Disk overcommit is not currently supported.'))
            raise exception.MigrationPreCheckError(reason=reason)

        dest_check_data = objects.SolarisZonesLiveMigrateData()
        dest_check_data.hypervisor_hostname = \
            dst_compute_info['hypervisor_hostname']
        return dest_check_data

    def check_can_live_migrate_destination_cleanup(self, context,
                                                   dest_check_data):
        """Do required cleanup on dest host after check_can_live_migrate calls

        :param context: security context
        :param dest_check_data: result of check_can_live_migrate_destination
        """
        pass

    def _check_local_volumes_present(self, block_device_info):
        """Check if local volumes are attached to the instance."""
        bmap = block_device_info.get('block_device_mapping')
        for entry in bmap:
            connection_info = entry['connection_info']
            driver_type = connection_info['driver_volume_type']
            if driver_type == 'local':
                reason = (_("Instances with attached '%s' volumes are not "
                            "currently supported.") % driver_type)
                raise exception.MigrationPreCheckError(reason=reason)

    def check_can_live_migrate_source(self, context, instance,
                                      dest_check_data, block_device_info=None):
        """Check if it is possible to execute live migration.

        This checks if the live migration can succeed, based on the
        results from check_can_live_migrate_destination.

        :param context: security context
        :param instance: nova.db.sqlalchemy.models.Instance
        :param dest_check_data: result of check_can_live_migrate_destination
        :param block_device_info: result of _get_instance_block_device_info
        :returns: a LiveMigrateData object
        """
        if not isinstance(dest_check_data, migrate_data_obj.LiveMigrateData):
            obj = objects.SolarisZonesLiveMigrateData()
            obj.from_legacy_dict(dest_check_data)
            dest_check_data = obj

        self._check_local_volumes_present(block_device_info)
        name = instance['name']
        dest = dest_check_data.hypervisor_hostname
        try:
            self._live_migration(name, dest, dry_run=True)
        except Exception as ex:
            reason = zonemgr_strerror(ex)
            raise exception.MigrationPreCheckError(reason=reason)
        return dest_check_data

    def get_instance_disk_info(self, instance,
                               block_device_info=None):
        """Retrieve information about actual disk sizes of an instance.

        :param instance: nova.objects.Instance
        :param block_device_info:
            Optional; Can be used to filter out devices which are
            actually volumes.
        :return:
            json strings with below format::

                "[{'path':'disk',
                   'type':'raw',
                   'virt_disk_size':'10737418240',
                   'backing_file':'backing_file',
                   'disk_size':'83886080'
                   'over_committed_disk_size':'10737418240'},
                   ...]"
        """
        raise NotImplementedError()

    def refresh_security_group_rules(self, security_group_id):
        """This method is called after a change to security groups.

        All security groups and their associated rules live in the datastore,
        and calling this method should apply the updated rules to instances
        running the specified security group.

        An error should be raised if the operation cannot complete.

        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def refresh_instance_security_rules(self, instance):
        """Refresh security group rules

        Gets called when an instance gets added to or removed from
        the security group the instance is a member of or if the
        group gains or loses a rule.
        """
        raise NotImplementedError()

    def reset_network(self, instance):
        """reset networking for specified instance."""
        # TODO(Vek): Need to pass context in for access to auth_token
        pass

    def ensure_filtering_rules_for_instance(self, instance, network_info):
        """Setting up filtering rules and waiting for its completion.

        To migrate an instance, filtering rules to hypervisors
        and firewalls are inevitable on destination host.
        ( Waiting only for filtering rules to hypervisor,
        since filtering rules to firewall rules can be set faster).

        Concretely, the below method must be called.
        - setup_basic_filtering (for nova-basic, etc.)
        - prepare_instance_filter(for nova-instance-instance-xxx, etc.)

        to_xml may have to be called since it defines PROJNET, PROJMASK.
        but libvirt migrates those value through migrateToURI(),
        so , no need to be called.

        Don't use thread for this method since migration should
        not be started when setting-up filtering rules operations
        are not completed.

        :param instance: nova.objects.instance.Instance object

        """
        # TODO(Vek): Need to pass context in for access to auth_token
        pass

    def filter_defer_apply_on(self):
        """Defer application of IPTables rules."""
        pass

    def filter_defer_apply_off(self):
        """Turn off deferral of IPTables rules and apply the rules now."""
        pass

    def unfilter_instance(self, instance, network_info):
        """Stop filtering instance."""
        # TODO(Vek): Need to pass context in for access to auth_token
        pass

    def set_admin_password(self, instance, new_pass):
        """Set the root password on the specified instance.

        :param instance: nova.objects.instance.Instance
        :param new_pass: the new password
        """
        name = instance['name']
        zone = self._get_zone_by_name(name)
        if zone is None:
            raise exception.InstanceNotFound(instance_id=name)

        if zone.state == ZONE_STATE_RUNNING:
            out, err = utils.execute('/usr/sbin/zlogin', '-S', name,
                                     '/usr/bin/passwd', '-p',
                                     "'%s'" % sha256_crypt.encrypt(new_pass))
        else:
            raise exception.InstanceNotRunning(instance_id=name)

    def inject_file(self, instance, b64_path, b64_contents):
        """Writes a file on the specified instance.

        The first parameter is an instance of nova.compute.service.Instance,
        and so the instance is being specified as instance.name. The second
        parameter is the base64-encoded path to which the file is to be
        written on the instance; the third is the contents of the file, also
        base64-encoded.

        NOTE(russellb) This method is deprecated and will be removed once it
        can be removed from nova.compute.manager.
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def change_instance_metadata(self, context, instance, diff):
        """Applies a diff to the instance metadata.

        This is an optional driver method which is used to publish
        changes to the instance's metadata to the hypervisor.  If the
        hypervisor has no means of publishing the instance metadata to
        the instance, then this method should not be implemented.

        :param context: security context
        :param instance: nova.objects.instance.Instance
        """
        pass

    def inject_network_info(self, instance, nw_info):
        """inject network info for specified instance."""
        # TODO(Vek): Need to pass context in for access to auth_token
        pass

    def poll_rebooting_instances(self, timeout, instances):
        """Perform a reboot on all given 'instances'.

        Reboots the given `instances` which are longer in the rebooting state
        than `timeout` seconds.

        :param int timeout:
            The timeout (in seconds) for considering rebooting instances
            to be stuck.
        :param list instances:
            A list of nova.objects.instance.Instance objects that have been
            in rebooting state longer than the configured timeout.

        :return: None
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def host_power_action(self, action):
        """Reboots, shuts down or powers up the host.

        :param str action:
            The action the host should perform. The valid actions are:
            ""startup", "shutdown" and "reboot".

        :return: The result of the power action
        :rtype: : str
        """

        raise NotImplementedError()

    def host_maintenance_mode(self, host, mode):
        """Start/Stop host maintenance window.

        On start, it triggers the migration of all instances to other hosts.
        Consider the combination with :func:`set_host_enabled`.

        :param str host:
            The name of the host whose maintenance mode should be changed.
        :param bool mode:
            If `True`, go into maintenance mode. If `False`, leave the
            maintenance mode.

        :return: "on_maintenance" if switched to maintenance mode or
                 "off_maintenance" if maintenance mode got left.
        :rtype: str
        """

        raise NotImplementedError()

    def set_host_enabled(self, enabled):
        """Sets the ability of this host to accept new instances.

        :param bool enabled:
            If this is `True`, the host will accept new instances. If it is
            `False`, the host won't accept new instances.

        :return: If the host can accept further instances, return "enabled",
                 if further instances shouldn't be scheduled to this host,
                 return "disabled".
        :rtype: str
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        raise NotImplementedError()

    def get_host_uptime(self):
        """Returns the result of calling the Linux command `uptime` on this
        host.

        :return: A text which contains the uptime of this host since the
                 last boot.
        :rtype: str
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        return utils.execute('/usr/bin/uptime')[0]

    def plug_vifs(self, instance, network_info):
        """Plug virtual interfaces (VIFs) into the given `instance` at
        instance boot time.

        The counter action is :func:`unplug_vifs`.

        :param nova.objects.instance.Instance instance:
            The instance which gets VIFs plugged.
        :param nova.network.model.NetworkInfo network_info:
            The object which contains information about the VIFs to plug.

        :return: None
        """
        # TODO(Vek): Need to pass context in for access to auth_token
        pass

    def unplug_vifs(self, instance, network_info):
        # NOTE(markus_z): 2015-08-18
        # The compute manager doesn't use this interface, which seems odd
        # since the manager should be the controlling thing here.
        """Unplug virtual interfaces (VIFs) from networks.

        The counter action is :func:`plug_vifs`.

        :param nova.objects.instance.Instance instance:
            The instance which gets VIFs unplugged.
        :param nova.network.model.NetworkInfo network_info:
            The object which contains information about the VIFs to unplug.

        :return: None
        """
        raise NotImplementedError()

    def get_host_cpu_stats(self):
        """Get the currently known host CPU stats.

        :returns: a dict containing the CPU stat info, eg:

            | {'kernel': kern,
            |  'idle': idle,
            |  'user': user,
            |  'iowait': wait,
            |   'frequency': freq},

                  where kern and user indicate the cumulative CPU time
                  (nanoseconds) spent by kernel and user processes
                  respectively, idle indicates the cumulative idle CPU time
                  (nanoseconds), wait indicates the cumulative I/O wait CPU
                  time (nanoseconds), since the host is booting up; freq
                  indicates the current CPU frequency (MHz). All values are
                  long integers.

        """
        raise NotImplementedError()

    def block_stats(self, instance, disk_id):
        """Return performance counters associated with the given disk_id on the
        given instance.  These are returned as [rd_req, rd_bytes, wr_req,
        wr_bytes, errs], where rd indicates read, wr indicates write, req is
        the total number of I/O requests made, bytes is the total number of
        bytes transferred, and errs is the number of requests held up due to a
        full pipeline.

        All counters are long integers.

        This method is optional.  On some platforms (e.g. XenAPI) performance
        statistics can be retrieved directly in aggregate form, without Nova
        having to do the aggregation.  On those platforms, this method is
        unused.

        Note that this function takes an instance ID.
        """
        raise NotImplementedError()

    def deallocate_networks_on_reschedule(self, instance):
        """Does the driver want networks deallocated on reschedule?"""
        return False

    def macs_for_instance(self, instance):
        """What MAC addresses must this instance have?

        Some hypervisors (such as bare metal) cannot do freeform virtualisation
        of MAC addresses. This method allows drivers to return a set of MAC
        addresses that the instance is to have. allocate_for_instance will take
        this into consideration when provisioning networking for the instance.

        Mapping of MAC addresses to actual networks (or permitting them to be
        freeform) is up to the network implementation layer. For instance,
        with openflow switches, fixed MAC addresses can still be virtualised
        onto any L2 domain, with arbitrary VLANs etc, but regular switches
        require pre-configured MAC->network mappings that will match the
        actual configuration.

        Most hypervisors can use the default implementation which returns None.
        Hypervisors with MAC limits should return a set of MAC addresses, which
        will be supplied to the allocate_for_instance call by the compute
        manager, and it is up to that call to ensure that all assigned network
        details are compatible with the set of MAC addresses.

        This is called during spawn_instance by the compute manager.

        :return: None, or a set of MAC ids (e.g. set(['12:34:56:78:90:ab'])).
            None means 'no constraints', a set means 'these and only these
            MAC addresses'.
        """
        return None

    def dhcp_options_for_instance(self, instance):
        """Get DHCP options for this instance.

        Some hypervisors (such as bare metal) require that instances boot from
        the network, and manage their own TFTP service. This requires passing
        the appropriate options out to the DHCP service. Most hypervisors can
        use the default implementation which returns None.

        This is called during spawn_instance by the compute manager.

        Note that the format of the return value is specific to the Neutron
        client API.

        :return: None, or a set of DHCP options, eg:

             |    [{'opt_name': 'bootfile-name',
             |      'opt_value': '/tftpboot/path/to/config'},
             |     {'opt_name': 'server-ip-address',
             |      'opt_value': '1.2.3.4'},
             |     {'opt_name': 'tftp-server',
             |      'opt_value': '1.2.3.4'}
             |    ]

        """
        return None

    def manage_image_cache(self, context, all_instances):
        """Manage the driver's local image cache.

        Some drivers chose to cache images for instances on disk. This method
        is an opportunity to do management of that cache which isn't directly
        related to other calls into the driver. The prime example is to clean
        the cache and remove images which are no longer of interest.

        :param all_instances: nova.objects.instance.InstanceList
        """
        pass

    def add_to_aggregate(self, context, aggregate, host, **kwargs):
        """Add a compute host to an aggregate.

        The counter action to this is :func:`remove_from_aggregate`

        :param nova.context.RequestContext context:
            The security context.
        :param nova.objects.aggregate.Aggregate aggregate:
            The aggregate which should add the given `host`
        :param str host:
            The name of the host to add to the given `aggregate`.
        :param dict kwargs:
            A free-form thingy...

        :return: None
        """
        # NOTE(jogo) Currently only used for XenAPI-Pool
        raise NotImplementedError()

    def remove_from_aggregate(self, context, aggregate, host, **kwargs):
        """Remove a compute host from an aggregate.

        The counter action to this is :func:`add_to_aggregate`

        :param nova.context.RequestContext context:
            The security context.
        :param nova.objects.aggregate.Aggregate aggregate:
            The aggregate which should remove the given `host`
        :param str host:
            The name of the host to remove from the given `aggregate`.
        :param dict kwargs:
            A free-form thingy...

        :return: None
        """
        raise NotImplementedError()

    def undo_aggregate_operation(self, context, op, aggregate,
                                 host, set_error=True):
        """Undo for Resource Pools."""
        raise NotImplementedError()

    def get_volume_connector(self, instance):
        """Get connector information for the instance for attaching to volumes.

        Connector information is a dictionary representing the ip of the
        machine that will be making the connection, the name of the iscsi
        initiator, the WWPN and WWNN values of the Fibre Channel initiator,
        and the hostname of the machine as follows::

            {
                'ip': ip,
                'initiator': initiator,
                'wwnns': wwnns,
                'wwpns': wwpns,
                'host': hostname
            }

        """
        connector = {
            'ip': self.get_host_ip_addr(),
            'host': CONF.host
        }
        if not self._initiator:
            self._initiator = self._get_iscsi_initiator()

        if self._initiator:
            connector['initiator'] = self._initiator
        else:
            LOG.debug(_("Could not determine iSCSI initiator name"),
                      instance=instance)

        if not self._fc_wwnns:
            self._fc_wwnns = self._get_fc_wwnns()
            if not self._fc_wwnns or len(self._fc_wwnns) == 0:
                LOG.debug(_('Could not determine Fibre Channel '
                          'World Wide Node Names'),
                          instance=instance)

        if not self._fc_wwpns:
            self._fc_wwpns = self._get_fc_wwpns()
            if not self._fc_wwpns or len(self._fc_wwpns) == 0:
                LOG.debug(_('Could not determine Fibre Channel '
                          'World Wide Port Names'),
                          instance=instance)

        if self._fc_wwnns and self._fc_wwpns:
            connector["wwnns"] = self._fc_wwnns
            connector["wwpns"] = self._fc_wwpns
        return connector

    def get_available_nodes(self, refresh=False):
        """Returns nodenames of all nodes managed by the compute service.

        This method is for multi compute-nodes support. If a driver supports
        multi compute-nodes, this method returns a list of nodenames managed
        by the service. Otherwise, this method should return
        [hypervisor_hostname].
        """
        if refresh or not self._host_stats:
            self._update_host_stats()
        stats = self._host_stats
        if not isinstance(stats, list):
            stats = [stats]
        return [s['hypervisor_hostname'] for s in stats]

    def node_is_available(self, nodename):
        """Return whether this compute service manages a particular node."""
        if nodename in self.get_available_nodes():
            return True
        # Refresh and check again.
        return nodename in self.get_available_nodes(refresh=True)

    def get_per_instance_usage(self):
        """Get information about instance resource usage.

        :returns: dict of  nova uuid => dict of usage info
        """
        return {}

    def instance_on_disk(self, instance):
        """Checks access of instance files on the host.

        :param instance: nova.objects.instance.Instance to lookup

        Returns True if files of an instance with the supplied ID accessible on
        the host, False otherwise.

        .. note::
            Used in rebuild for HA implementation and required for validation
            of access to instance shared disk files
        """
        bdmobj = objects.BlockDeviceMappingList
        bdms = bdmobj.get_by_instance_uuid(nova_context.get_admin_context(),
                                           instance['uuid'])

        root_ci = None
        rootmp = instance['root_device_name']
        for entry in bdms:
            if entry['connection_info'] is None:
                continue

            if entry['device_name'] == rootmp:
                root_ci = jsonutils.loads(entry['connection_info'])
                break

        if root_ci is None:
            msg = (_("Unable to find the root device for instance '%s'.")
                   % instance['name'])
            raise exception.NovaException(msg)

        driver_type = root_ci['driver_volume_type']
        return driver_type in shared_storage

    def register_event_listener(self, callback):
        """Register a callback to receive events.

        Register a callback to receive asynchronous event
        notifications from hypervisors. The callback will
        be invoked with a single parameter, which will be
        an instance of the nova.virt.event.Event class.
        """

        self._compute_event_callback = callback

    def emit_event(self, event):
        """Dispatches an event to the compute manager.

        Invokes the event callback registered by the
        compute manager to dispatch the event. This
        must only be invoked from a green thread.
        """

        if not self._compute_event_callback:
            LOG.debug("Discarding event %s", str(event))
            return

        if not isinstance(event, virtevent.Event):
            raise ValueError(
                _("Event must be an instance of nova.virt.event.Event"))

        try:
            LOG.debug("Emitting event %s", str(event))
            self._compute_event_callback(event)
        except Exception as ex:
            LOG.error(_LE("Exception dispatching event %(event)s: %(ex)s"),
                      {'event': event, 'ex': ex})

    def delete_instance_files(self, instance):
        """Delete any lingering instance files for an instance.

        :param instance: nova.objects.instance.Instance
        :returns: True if the instance was deleted from disk, False otherwise.
        """
        # Delete the zone configuration for the instance using destroy, because
        # it will simply take care of the work, and we don't need to duplicate
        # the code here.
        LOG.debug(_("Cleaning up for instance %s"), instance['name'])
        try:
            self.destroy(None, instance, None)
        except Exception:
            return False
        return True

    @property
    def need_legacy_block_device_info(self):
        """Tell the caller if the driver requires legacy block device info.

        Tell the caller whether we expect the legacy format of block
        device info to be passed in to methods that expect it.
        """
        return True

    def volume_snapshot_create(self, context, instance, volume_id,
                               create_info):
        """Snapshots volumes attached to a specified instance.

        The counter action to this is :func:`volume_snapshot_delete`

        :param nova.context.RequestContext context:
            The security context.
        :param nova.objects.instance.Instance  instance:
            The instance that has the volume attached
        :param uuid volume_id:
            Volume to be snapshotted
        :param create_info: The data needed for nova to be able to attach
               to the volume.  This is the same data format returned by
               Cinder's initialize_connection() API call.  In the case of
               doing a snapshot, it is the image file Cinder expects to be
               used as the active disk after the snapshot operation has
               completed.  There may be other data included as well that is
               needed for creating the snapshot.
        """
        raise NotImplementedError()

    def volume_snapshot_delete(self, context, instance, volume_id,
                               snapshot_id, delete_info):
        """Deletes a snapshot of a volume attached to a specified instance.

        The counter action to this is :func:`volume_snapshot_create`

        :param nova.context.RequestContext context:
            The security context.
        :param nova.objects.instance.Instance instance:
            The instance that has the volume attached.
        :param uuid volume_id:
            Attached volume associated with the snapshot
        :param uuid snapshot_id:
            The snapshot to delete.
        :param dict delete_info:
            Volume backend technology specific data needed to be able to
            complete the snapshot.  For example, in the case of qcow2 backed
            snapshots, this would include the file being merged, and the file
            being merged into (if appropriate).

        :return: None
        """
        raise NotImplementedError()

    def default_root_device_name(self, instance, image_meta, root_bdm):
        """Provide a default root device name for the driver.

        :param nova.objects.instance.Instance instance:
            The instance to get the root device for.
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        :param nova.objects.BlockDeviceMapping root_bdm:
            The description of the root device.
        """
        raise NotImplementedError()

    def default_device_names_for_instance(self, instance, root_device_name,
                                          *block_device_lists):
        """Default the missing device names in the block device mapping."""
        raise NotImplementedError()

    def get_device_name_for_instance(self, instance,
                                     bdms, block_device_obj):
        """Get the next device name based on the block device mapping.

        :param instance: nova.objects.instance.Instance that volume is
                         requesting a device name
        :param bdms: a nova.objects.BlockDeviceMappingList for the instance
        :param block_device_obj: A nova.objects.BlockDeviceMapping instance
                                 with all info about the requested block
                                 device. device_name does not need to be set,
                                 and should be decided by the driver
                                 implementation if not set.

        :returns: The chosen device name.
        """
        raise NotImplementedError()

    def is_supported_fs_format(self, fs_type):
        """Check whether the file format is supported by this driver

        :param fs_type: the file system type to be checked,
                        the validate values are defined at disk API module.
        """
        # NOTE(jichenjc): Return False here so that every hypervisor
        #                 need to define their supported file system
        #                 type and implement this function at their
        #                 virt layer.
        return False

    def quiesce(self, context, instance, image_meta):
        """Quiesce the specified instance to prepare for snapshots.

        If the specified instance doesn't support quiescing,
        InstanceQuiesceNotSupported is raised. When it fails to quiesce by
        other errors (e.g. agent timeout), NovaException is raised.

        :param context:  request context
        :param instance: nova.objects.instance.Instance to be quiesced
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        """
        raise NotImplementedError()

    def unquiesce(self, context, instance, image_meta):
        """Unquiesce the specified instance after snapshots.

        If the specified instance doesn't support quiescing,
        InstanceQuiesceNotSupported is raised. When it fails to quiesce by
        other errors (e.g. agent timeout), NovaException is raised.

        :param context:  request context
        :param instance: nova.objects.instance.Instance to be unquiesced
        :param nova.objects.ImageMeta image_meta:
            The metadata of the image of the instance.
        """
        raise NotImplementedError()

    def network_binding_host_id(self, context, instance):
        """Get host ID to associate with network ports.

        :param context:  request context
        :param instance: nova.objects.instance.Instance that the network
                         ports will be associated with
        :returns: a string representing the host ID
        """
        return instance.get('host')