FM / v2

/usr/lib/python2.6/site-packages/novaclient/v2/

/usr/lib/python2.6/site-packages/novaclient/v2

Name	Size	Mode	Actions
contrib/	-	0755	rm
agents.py	2240	0644	edit dl rm
agents.pyc	2774	0644	edit dl rm
aggregates.py	3500	0644	edit dl rm
aggregates.pyc	4777	0644	edit dl rm
availability_zones.py	1588	0644	edit dl rm
availability_zones.pyc	1703	0644	edit dl rm
certs.py	1410	0644	edit dl rm
certs.pyc	1651	0644	edit dl rm
client.py	9859	0644	edit dl rm
client.pyc	8652	0644	edit dl rm
cloudpipe.py	1906	0644	edit dl rm
cloudpipe.pyc	2474	0644	edit dl rm
fixed_ips.py	1683	0644	edit dl rm
fixed_ips.pyc	2099	0644	edit dl rm
flavors.py	6824	0644	edit dl rm
flavors.pyc	7623	0644	edit dl rm
flavor_access.py	2654	0644	edit dl rm
flavor_access.pyc	3257	0644	edit dl rm
floating_ips.py	1730	0644	edit dl rm
floating_ips.pyc	2222	0644	edit dl rm
floating_ips_bulk.py	2108	0644	edit dl rm
floating_ips_bulk.pyc	2286	0644	edit dl rm
floating_ip_dns.py	4378	0644	edit dl rm
floating_ip_dns.pyc	6260	0644	edit dl rm
floating_ip_pools.py	1064	0644	edit dl rm
floating_ip_pools.pyc	1255	0644	edit dl rm
fping.py	1750	0644	edit dl rm
fping.pyc	2039	0644	edit dl rm
hosts.py	2094	0644	edit dl rm
hosts.pyc	3254	0644	edit dl rm
hypervisors.py	2826	0644	edit dl rm
hypervisors.pyc	4042	0644	edit dl rm
images.py	3151	0644	edit dl rm
images.pyc	4137	0644	edit dl rm
keypairs.py	3497	0644	edit dl rm
keypairs.pyc	3944	0644	edit dl rm
limits.py	3092	0644	edit dl rm
limits.pyc	4311	0644	edit dl rm
networks.py	4815	0644	edit dl rm
networks.pyc	5836	0644	edit dl rm
quotas.py	2264	0644	edit dl rm
quotas.pyc	2619	0644	edit dl rm
quota_classes.py	1500	0644	edit dl rm
quota_classes.pyc	1775	0644	edit dl rm
security_groups.py	3000	0644	edit dl rm
security_groups.pyc	4121	0644	edit dl rm
security_group_default_rules.py	2741	0644	edit dl rm
security_group_default_rules.pyc	3326	0644	edit dl rm
security_group_rules.py	2681	0644	edit dl rm
security_group_rules.pyc	2988	0644	edit dl rm
servers.py	45064	0644	edit dl rm
servers.pyc	50236	0644	edit dl rm
server_groups.py	2060	0644	edit dl rm
server_groups.pyc	2811	0644	edit dl rm
server_migrations.py	2924	0644	edit dl rm
server_migrations.pyc	3332	0644	edit dl rm
services.py	3305	0644	edit dl rm
services.pyc	4098	0644	edit dl rm
shell.py	148685	0644	edit dl rm
shell.pyc	149090	0644	edit dl rm
usage.py	2019	0644	edit dl rm
usage.pyc	2327	0644	edit dl rm
versions.py	3032	0644	edit dl rm
versions.pyc	2634	0644	edit dl rm
virtual_interfaces.py	1039	0644	edit dl rm
virtual_interfaces.pyc	1252	0644	edit dl rm
volumes.py	7731	0644	edit dl rm
volumes.pyc	8088	0644	edit dl rm
volume_snapshots.py	4475	0644	edit dl rm
volume_snapshots.pyc	4779	0644	edit dl rm
volume_types.py	3698	0644	edit dl rm
volume_types.pyc	3989	0644	edit dl rm
__init__.py	649	0644	edit dl rm
__init__.pyc	219	0644	edit dl rm

Edit: /usr/lib/python2.6/site-packages/novaclient/v2/servers.py (45064B)

# Copyright 2011 OpenStack Foundation
# 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.

"""
Server interface.
"""

import base64

from oslo_utils import encodeutils
import six
from six.moves.urllib import parse

from novaclient import base
from novaclient import crypto
from novaclient.i18n import _
from novaclient.v2 import security_groups

REBOOT_SOFT, REBOOT_HARD = 'SOFT', 'HARD'

class Server(base.Resource):
    HUMAN_ID = True

def __repr__(self):
        return '<Server: %s>' % getattr(self, 'name', 'unknown-name')

def delete(self):
        """
        Delete (i.e. shut down and delete the image) this server.
        """
        self.manager.delete(self)

def update(self, name=None):
        """
        Update the name for this server.

:param name: Update the server's name.
        """
        self.manager.update(self, name=name)

def get_console_output(self, length=None):
        """
        Get text console log output from Server.

:param length: The number of lines you would like to retrieve (as int)
        """
        return self.manager.get_console_output(self, length)

def get_vnc_console(self, console_type):
        """
        Get vnc console for a Server.

:param console_type: Type of console ('novnc' or 'xvpvnc')
        """
        return self.manager.get_vnc_console(self, console_type)

def get_spice_console(self, console_type):
        """
        Get spice console for a Server.

:param console_type: Type of console ('spice-html5')
        """
        return self.manager.get_spice_console(self, console_type)

def get_rdp_console(self, console_type):
        """
        Get rdp console for a Server.

:param console_type: Type of console ('rdp-html5')
        """
        return self.manager.get_rdp_console(self, console_type)

def get_serial_console(self, console_type):
        """
        Get serial console for a Server.

:param console_type: Type of console ('serial')
        """
        return self.manager.get_serial_console(self, console_type)

def get_password(self, private_key=None):
        """
        Get password for a Server.

Returns the clear password of an instance if private_key is
        provided, returns the ciphered password otherwise.

:param private_key: Path to private key file for decryption
                            (optional)
        """
        return self.manager.get_password(self, private_key)

def clear_password(self):
        """
        Get password for a Server.

"""
        return self.manager.clear_password(self)

def add_fixed_ip(self, network_id):
        """
        Add an IP address on a network.

:param network_id: The ID of the network the IP should be on.
        """
        self.manager.add_fixed_ip(self, network_id)

def add_floating_ip(self, address, fixed_address=None):
        """
        Add floating IP to an instance

:param address: The IP address or FloatingIP to add to the instance
        :param fixed_address: The fixedIP address the FloatingIP is to be
               associated with (optional)
        """
        self.manager.add_floating_ip(self, address, fixed_address)

def remove_floating_ip(self, address):
        """
        Remove floating IP from an instance

:param address: The IP address or FloatingIP to remove
        """
        self.manager.remove_floating_ip(self, address)

def stop(self):
        """
        Stop -- Stop the running server.
        """
        self.manager.stop(self)

def force_delete(self):
        """
        Force delete -- Force delete a server.
        """
        self.manager.force_delete(self)

def restore(self):
        """
        Restore -- Restore a server in 'soft-deleted' state.
        """
        self.manager.restore(self)

def start(self):
        """
        Start -- Start the paused server.
        """
        self.manager.start(self)

def pause(self):
        """
        Pause -- Pause the running server.
        """
        self.manager.pause(self)

def unpause(self):
        """
        Unpause -- Unpause the paused server.
        """
        self.manager.unpause(self)

def lock(self):
        """
        Lock -- Lock the instance from certain operations.
        """
        self.manager.lock(self)

def unlock(self):
        """
        Unlock -- Remove instance lock.
        """
        self.manager.unlock(self)

def suspend(self):
        """
        Suspend -- Suspend the running server.
        """
        self.manager.suspend(self)

def resume(self):
        """
        Resume -- Resume the suspended server.
        """
        self.manager.resume(self)

def rescue(self, password=None, image=None):
        """
        Rescue -- Rescue the problematic server.

:param password: The admin password to be set in the rescue instance.
        :param image: The :class:`Image` to rescue with.
        """
        return self.manager.rescue(self, password, image)

def unrescue(self):
        """
        Unrescue -- Unrescue the rescued server.
        """
        self.manager.unrescue(self)

def shelve(self):
        """
        Shelve -- Shelve the server.
        """
        self.manager.shelve(self)

def shelve_offload(self):
        """
        Shelve_offload -- Remove a shelved server from the compute node.
        """
        self.manager.shelve_offload(self)

def unshelve(self):
        """
        Unshelve -- Unshelve the server.
        """
        self.manager.unshelve(self)

def diagnostics(self):
        """Diagnostics -- Retrieve server diagnostics."""
        return self.manager.diagnostics(self)

def migrate(self):
        """
        Migrate a server to a new host.
        """
        self.manager.migrate(self)

def remove_fixed_ip(self, address):
        """
        Remove an IP address.

:param address: The IP address to remove.
        """
        self.manager.remove_fixed_ip(self, address)

def change_password(self, password):
        """
        Update the admin password for a server.

:param password: string to set as the admin password on the server
        """
        self.manager.change_password(self, password)

def reboot(self, reboot_type=REBOOT_SOFT):
        """
        Reboot the server.

:param reboot_type: either :data:`REBOOT_SOFT` for a software-level
                reboot, or `REBOOT_HARD` for a virtual power cycle hard reboot.
        """
        self.manager.reboot(self, reboot_type)

def rebuild(self, image, password=None, preserve_ephemeral=False,
                **kwargs):
        """
        Rebuild -- shut down and then re-image -- this server.

:param image: the :class:`Image` (or its ID) to re-image with.
        :param password: string to set as the admin password on the rebuilt
                         server.
        :param preserve_ephemeral: If True, request that any ephemeral device
            be preserved when rebuilding the instance. Defaults to False.
        """
        return self.manager.rebuild(self, image, password=password,
                                    preserve_ephemeral=preserve_ephemeral,
                                    **kwargs)

def resize(self, flavor, **kwargs):
        """
        Resize the server's resources.

:param flavor: the :class:`Flavor` (or its ID) to resize to.

Until a resize event is confirmed with :meth:`confirm_resize`, the old
        server will be kept around and you'll be able to roll back to the old
        flavor quickly with :meth:`revert_resize`. All resizes are
        automatically confirmed after 24 hours.
        """
        self.manager.resize(self, flavor, **kwargs)

def create_image(self, image_name, metadata=None):
        """
        Create an image based on this server.

:param image_name: The name to assign the newly create image.
        :param metadata: Metadata to assign to the image.
        """
        return self.manager.create_image(self, image_name, metadata)

def backup(self, backup_name, backup_type, rotation):
        """
        Backup a server instance.

:param backup_name: Name of the backup image
        :param backup_type: The backup type, like 'daily' or 'weekly'
        :param rotation: Int parameter representing how many backups to
                        keep around.
        """
        self.manager.backup(self, backup_name, backup_type, rotation)

def confirm_resize(self):
        """
        Confirm that the resize worked, thus removing the original server.
        """
        self.manager.confirm_resize(self)

def revert_resize(self):
        """
        Revert a previous resize, switching back to the old server.
        """
        self.manager.revert_resize(self)

@property
    def networks(self):
        """
        Generate a simplified list of addresses
        """
        networks = {}
        try:
            for network_label, address_list in self.addresses.items():
                networks[network_label] = [a['addr'] for a in address_list]
            return networks
        except Exception:
            return {}

def live_migrate(self, host=None,
                     block_migration=False,
                     disk_over_commit=False):
        """
        Migrates a running instance to a new machine.
        """
        self.manager.live_migrate(self, host,
                                  block_migration,
                                  disk_over_commit)

def reset_state(self, state='error'):
        """
        Reset the state of an instance to active or error.
        """
        self.manager.reset_state(self, state)

def reset_network(self):
        """
        Reset network of an instance.
        """
        self.manager.reset_network(self)

def add_security_group(self, security_group):
        """
        Add a security group to an instance.
        """
        self.manager.add_security_group(self, security_group)

def remove_security_group(self, security_group):
        """
        Remove a security group from an instance.
        """
        self.manager.remove_security_group(self, security_group)

def list_security_group(self):
        """
        List security group(s) of an instance.
        """
        return self.manager.list_security_group(self)

def evacuate(self, host=None, on_shared_storage=True, password=None):
        """
        Evacuate an instance from failed host to specified host.

:param host: Name of the target host
        :param on_shared_storage: Specifies whether instance files located
                        on shared storage
        :param password: string to set as admin password on the evacuated
                         server.
        """
        return self.manager.evacuate(self, host, on_shared_storage, password)

def interface_list(self):
        """
        List interfaces attached to an instance.
        """
        return self.manager.interface_list(self)

def interface_attach(self, port_id, net_id, fixed_ip):
        """
        Attach a network interface to an instance.
        """
        return self.manager.interface_attach(self, port_id, net_id, fixed_ip)

def interface_detach(self, port_id):
        """
        Detach a network interface from an instance.
        """
        return self.manager.interface_detach(self, port_id)

class ServerManager(base.BootingManagerWithFind):
    resource_class = Server

def _boot(self, resource_url, response_key, name, image, flavor,
              meta=None, files=None, userdata=None,
              reservation_id=None, return_raw=False, min_count=None,
              max_count=None, security_groups=None, key_name=None,
              availability_zone=None, block_device_mapping=None,
              block_device_mapping_v2=None, nics=None, scheduler_hints=None,
              config_drive=None, admin_pass=None, disk_config=None, **kwargs):
        """
        Create (boot) a new server.
        """
        body = {"server": {
            "name": name,
            "imageRef": str(base.getid(image)) if image else '',
            "flavorRef": str(base.getid(flavor)),
        }}
        if userdata:
            if hasattr(userdata, 'read'):
                userdata = userdata.read()

# NOTE(melwitt): Text file data is converted to bytes prior to
            # base64 encoding. The utf-8 encoding will fail for binary files.
            if six.PY3:
                try:
                    userdata = userdata.encode("utf-8")
                except AttributeError:
                    # In python 3, 'bytes' object has no attribute 'encode'
                    pass
            else:
                try:
                    userdata = encodeutils.safe_encode(userdata)
                except UnicodeDecodeError:
                    pass

userdata_b64 = base64.b64encode(userdata).decode('utf-8')
            body["server"]["user_data"] = userdata_b64
        if meta:
            body["server"]["metadata"] = meta
        if reservation_id:
            body["server"]["reservation_id"] = reservation_id
        if key_name:
            body["server"]["key_name"] = key_name
        if scheduler_hints:
            body['os:scheduler_hints'] = scheduler_hints
        if config_drive:
            body["server"]["config_drive"] = config_drive
        if admin_pass:
            body["server"]["adminPass"] = admin_pass
        if not min_count:
            min_count = 1
        if not max_count:
            max_count = min_count
        body["server"]["min_count"] = min_count
        body["server"]["max_count"] = max_count

if security_groups:
            body["server"]["security_groups"] = [{'name': sg}
                                                 for sg in security_groups]

# Files are a slight bit tricky. They're passed in a "personality"
        # list to the POST. Each item is a dict giving a file name and the
        # base64-encoded contents of the file. We want to allow passing
        # either an open file *or* some contents as files here.
        if files:
            personality = body['server']['personality'] = []
            for filepath, file_or_string in sorted(files.items(),
                                                   key=lambda x: x[0]):
                if hasattr(file_or_string, 'read'):
                    data = file_or_string.read()
                else:
                    data = file_or_string

if six.PY3 and isinstance(data, str):
                    data = data.encode('utf-8')
                cont = base64.b64encode(data).decode('utf-8')
                personality.append({
                    'path': filepath,
                    'contents': cont,
                })

if availability_zone:
            body["server"]["availability_zone"] = availability_zone

# Block device mappings are passed as a list of dictionaries
        if block_device_mapping:
            body['server']['block_device_mapping'] = \
                self._parse_block_device_mapping(block_device_mapping)
        elif block_device_mapping_v2:
            # Following logic can't be removed because it will leaves
            # a valid boot with both --image and --block-device
            # failed , see bug 1433609 for more info
            if image:
                bdm_dict = {'uuid': base.getid(image), 'source_type': 'image',
                            'destination_type': 'local', 'boot_index': 0,
                            'delete_on_termination': True}
                block_device_mapping_v2.insert(0, bdm_dict)
            body['server']['block_device_mapping_v2'] = block_device_mapping_v2

if nics is not None:
            # NOTE(tr3buchet): nics can be an empty list
            all_net_data = []
            for nic_info in nics:
                net_data = {}
                # if value is empty string, do not send value in body
                if nic_info.get('net-id'):
                    net_data['uuid'] = nic_info['net-id']
                if (nic_info.get('v4-fixed-ip') and
                        nic_info.get('v6-fixed-ip')):
                    raise base.exceptions.CommandError(_(
                        "Only one of 'v4-fixed-ip' and 'v6-fixed-ip' may be"
                        " provided."))
                elif nic_info.get('v4-fixed-ip'):
                    net_data['fixed_ip'] = nic_info['v4-fixed-ip']
                elif nic_info.get('v6-fixed-ip'):
                    net_data['fixed_ip'] = nic_info['v6-fixed-ip']
                if nic_info.get('port-id'):
                    net_data['port'] = nic_info['port-id']
                all_net_data.append(net_data)
            body['server']['networks'] = all_net_data

if disk_config is not None:
            body['server']['OS-DCF:diskConfig'] = disk_config

return self._create(resource_url, body, response_key,
                            return_raw=return_raw, **kwargs)

def get(self, server):
        """
        Get a server.

:param server: ID of the :class:`Server` to get.
        :rtype: :class:`Server`
        """
        return self._get("/servers/%s" % base.getid(server), "server")

def list(self, detailed=True, search_opts=None, marker=None, limit=None,
             sort_keys=None, sort_dirs=None):
        """
        Get a list of servers.

:param detailed: Whether to return detailed server info (optional).
        :param search_opts: Search options to filter out servers (optional).
        :param marker: Begin returning servers that appear later in the server
                       list than that represented by this server id (optional).
        :param limit: Maximum number of servers to return (optional).
        :param sort_keys: List of sort keys
        :param sort_dirs: List of sort directions

:rtype: list of :class:`Server`
        """
        if search_opts is None:
            search_opts = {}

qparams = {}

for opt, val in six.iteritems(search_opts):
            if val:
                if isinstance(val, six.text_type):
                    val = val.encode('utf-8')
                qparams[opt] = val

detail = ""
        if detailed:
            detail = "/detail"

result = []
        while True:
            if marker:
                qparams['marker'] = marker

if limit and limit != -1:
                qparams['limit'] = limit

# Transform the dict to a sequence of two-element tuples in fixed
            # order, then the encoded string will be consistent in Python 2&3.
            if qparams or sort_keys or sort_dirs:
                # sort keys and directions are unique since the same parameter
                # key is repeated for each associated value
                # (ie, &sort_key=key1&sort_key=key2&sort_key=key3)
                items = list(qparams.items())
                if sort_keys:
                    items.extend(('sort_key', sort_key)
                                 for sort_key in sort_keys)
                if sort_dirs:
                    items.extend(('sort_dir', sort_dir)
                                 for sort_dir in sort_dirs)
                new_qparams = sorted(items, key=lambda x: x[0])
                query_string = "?%s" % parse.urlencode(new_qparams)
            else:
                query_string = ""

servers = self._list("/servers%s%s" % (detail, query_string),
                                 "servers")
            result.extend(servers)

if not servers or limit != -1:
                break
            marker = result[-1].id
        return result

def add_fixed_ip(self, server, network_id):
        """
        Add an IP address on a network.

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param network_id: The ID of the network the IP should be on.
        """
        self._action('addFixedIp', server, {'networkId': network_id})

def remove_fixed_ip(self, server, address):
        """
        Remove an IP address.

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param address: The IP address to remove.
        """
        self._action('removeFixedIp', server, {'address': address})

def add_floating_ip(self, server, address, fixed_address=None):
        """
        Add a floating IP to an instance

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param address: The FloatingIP or string floating address to add.
        :param fixed_address: The FixedIP the floatingIP should be
                              associated with (optional)
        """

address = address.ip if hasattr(address, 'ip') else address
        if fixed_address:
            if hasattr(fixed_address, 'ip'):
                fixed_address = fixed_address.ip
            self._action('addFloatingIp', server,
                         {'address': address, 'fixed_address': fixed_address})
        else:
            self._action('addFloatingIp', server, {'address': address})

def remove_floating_ip(self, server, address):
        """
        Remove a floating IP address.

:param server: The :class:`Server` (or its ID) to remove an IP from.
        :param address: The FloatingIP or string floating address to remove.
        """

address = address.ip if hasattr(address, 'ip') else address
        self._action('removeFloatingIp', server, {'address': address})

def get_vnc_console(self, server, console_type):
        """
        Get a vnc console for an instance

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param console_type: Type of vnc console to get ('novnc' or 'xvpvnc')
        """

return self._action('os-getVNCConsole', server,
                            {'type': console_type})[1]

def get_spice_console(self, server, console_type):
        """
        Get a spice console for an instance

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param console_type: Type of spice console to get ('spice-html5')
        """

return self._action('os-getSPICEConsole', server,
                            {'type': console_type})[1]

def get_rdp_console(self, server, console_type):
        """
        Get a rdp console for an instance

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param console_type: Type of rdp console to get ('rdp-html5')
        """

return self._action('os-getRDPConsole', server,
                            {'type': console_type})[1]

def get_serial_console(self, server, console_type):
        """
        Get a serial console for an instance

:param server: The :class:`Server` (or its ID) to add an IP to.
        :param console_type: Type of serial console to get ('serial')
        """

return self._action('os-getSerialConsole', server,
                            {'type': console_type})[1]

def get_password(self, server, private_key=None):
        """
        Get admin password of an instance

Returns the admin password of an instance in the clear if private_key
        is provided, returns the ciphered password otherwise.

Requires that openssl is installed and in the path

:param server: The :class:`Server` (or its ID) for which the admin
                       password is to be returned
        :param private_key: The private key to decrypt password
                            (optional)
        """

_resp, body = self.api.client.get("/servers/%s/os-server-password"
                                          % base.getid(server))
        ciphered_pw = body.get('password', '') if body else ''
        if private_key and ciphered_pw:
            try:
                return crypto.decrypt_password(private_key, ciphered_pw)
            except Exception as exc:
                return '%sFailed to decrypt:\n%s' % (exc, ciphered_pw)
        return ciphered_pw

def clear_password(self, server):
        """
        Clear the admin password of an instance

Remove the admin password for an instance from the metadata server.

:param server: The :class:`Server` (or its ID) for which the admin
                       password is to be cleared
        """

return self._delete("/servers/%s/os-server-password"
                            % base.getid(server))

def stop(self, server):
        """
        Stop the server.
        """
        return self._action('os-stop', server, None)

def force_delete(self, server):
        """
        Force delete the server.
        """
        return self._action('forceDelete', server, None)

def restore(self, server):
        """
        Restore soft-deleted server.
        """
        return self._action('restore', server, None)

def start(self, server):
        """
        Start the server.
        """
        self._action('os-start', server, None)

def pause(self, server):
        """
        Pause the server.
        """
        self._action('pause', server, None)

def unpause(self, server):
        """
        Unpause the server.
        """
        self._action('unpause', server, None)

def lock(self, server):
        """
        Lock the server.
        """
        self._action('lock', server, None)

def unlock(self, server):
        """
        Unlock the server.
        """
        self._action('unlock', server, None)

def suspend(self, server):
        """
        Suspend the server.
        """
        self._action('suspend', server, None)

def resume(self, server):
        """
        Resume the server.
        """
        self._action('resume', server, None)

def rescue(self, server, password=None, image=None):
        """
        Rescue the server.

:param server: The :class:`Server` to rescue.
        :param password: The admin password to be set in the rescue instance.
        :param image: The :class:`Image` to rescue with.
        """
        info = {}
        if password:
            info['adminPass'] = password
        if image:
            info['rescue_image_ref'] = base.getid(image)
        return self._action('rescue', server, info or None)

def unrescue(self, server):
        """
        Unrescue the server.
        """
        self._action('unrescue', server, None)

def shelve(self, server):
        """
        Shelve the server.
        """
        self._action('shelve', server, None)

def shelve_offload(self, server):
        """
        Remove a shelved instance from the compute node.
        """
        self._action('shelveOffload', server, None)

def unshelve(self, server):
        """
        Unshelve the server.
        """
        self._action('unshelve', server, None)

def ips(self, server):
        """
        Return IP Addresses associated with the server.

Often a cheaper call then getting all the details for a server.
        """
        _resp, body = self.api.client.get("/servers/%s/ips" %
                                          base.getid(server))
        return body['addresses']

def diagnostics(self, server):
        """Retrieve server diagnostics."""
        return self.api.client.get("/servers/%s/diagnostics" %
                                   base.getid(server))

def create(self, name, image, flavor, meta=None, files=None,
               reservation_id=None, min_count=None,
               max_count=None, security_groups=None, userdata=None,
               key_name=None, availability_zone=None,
               block_device_mapping=None, block_device_mapping_v2=None,
               nics=None, scheduler_hints=None,
               config_drive=None, disk_config=None, admin_pass=None, **kwargs):
        # TODO(anthony): indicate in doc string if param is an extension
        # and/or optional
        """
        Create (boot) a new server.

:param name: Something to name the server.
        :param image: The :class:`Image` to boot with.
        :param flavor: The :class:`Flavor` to boot onto.
        :param meta: A dict of arbitrary key/value metadata to store for this
                     server. Both keys and values must be <=255 characters.
        :param files: A dict of files to overwrite on the server upon boot.
                      Keys are file names (i.e. ``/etc/passwd``) and values
                      are the file contents (either as a string or as a
                      file-like object). A maximum of five entries is allowed,
                      and each file must be 10k or less.
        :param reservation_id: a UUID for the set of servers being requested.
        :param min_count: (optional extension) The minimum number of
                          servers to launch.
        :param max_count: (optional extension) The maximum number of
                          servers to launch.
        :param security_groups: A list of security group names
        :param userdata: user data to pass to be exposed by the metadata
                      server this can be a file type object as well or a
                      string.
        :param key_name: (optional extension) name of previously created
                      keypair to inject into the instance.
        :param availability_zone: Name of the availability zone for instance
                                  placement.
        :param block_device_mapping: (optional extension) A dict of block
                      device mappings for this server.
        :param block_device_mapping_v2: (optional extension) A dict of block
                      device mappings for this server.
        :param nics:  (optional extension) an ordered list of nics to be
                      added to this server, with information about
                      connected networks, fixed IPs, port etc.
        :param scheduler_hints: (optional extension) arbitrary key-value pairs
                            specified by the client to help boot an instance
        :param config_drive: (optional extension) value for config drive
                            either boolean, or volume-id
        :param disk_config: (optional extension) control how the disk is
                            partitioned when the server is created.  possible
                            values are 'AUTO' or 'MANUAL'.
        :param admin_pass: (optional extension) add a user supplied admin
                           password.
        """
        if not min_count:
            min_count = 1
        if not max_count:
            max_count = min_count
        if min_count > max_count:
            min_count = max_count

boot_args = [name, image, flavor]

boot_kwargs = dict(
            meta=meta, files=files, userdata=userdata,
            reservation_id=reservation_id, min_count=min_count,
            max_count=max_count, security_groups=security_groups,
            key_name=key_name, availability_zone=availability_zone,
            scheduler_hints=scheduler_hints, config_drive=config_drive,
            disk_config=disk_config, admin_pass=admin_pass, **kwargs)

if block_device_mapping:
            resource_url = "/os-volumes_boot"
            boot_kwargs['block_device_mapping'] = block_device_mapping
        elif block_device_mapping_v2:
            resource_url = "/os-volumes_boot"
            boot_kwargs['block_device_mapping_v2'] = block_device_mapping_v2
        else:
            resource_url = "/servers"
        if nics:
            boot_kwargs['nics'] = nics

response_key = "server"
        return self._boot(resource_url, response_key, *boot_args,
                          **boot_kwargs)

def update(self, server, name=None):
        """
        Update the name or the password for a server.

:param server: The :class:`Server` (or its ID) to update.
        :param name: Update the server's name.
        """
        if name is None:
            return

body = {
            "server": {
                "name": name,
            },
        }

return self._update("/servers/%s" % base.getid(server), body, "server")

def change_password(self, server, password):
        """
        Update the password for a server.
        """
        self._action("changePassword", server, {"adminPass": password})

def delete(self, server):
        """
        Delete (i.e. shut down and delete the image) this server.
        """
        self._delete("/servers/%s" % base.getid(server))

def reboot(self, server, reboot_type=REBOOT_SOFT):
        """
        Reboot a server.

:param server: The :class:`Server` (or its ID) to share onto.
        :param reboot_type: either :data:`REBOOT_SOFT` for a software-level
                reboot, or `REBOOT_HARD` for a virtual power cycle hard reboot.
        """
        self._action('reboot', server, {'type': reboot_type})

def rebuild(self, server, image, password=None, disk_config=None,
                preserve_ephemeral=False, name=None, meta=None, files=None,
                **kwargs):
        """
        Rebuild -- shut down and then re-image -- a server.

:param server: The :class:`Server` (or its ID) to share onto.
        :param image: the :class:`Image` (or its ID) to re-image with.
        :param password: string to set as password on the rebuilt server.
        :param disk_config: partitioning mode to use on the rebuilt server.
                            Valid values are 'AUTO' or 'MANUAL'
        :param preserve_ephemeral: If True, request that any ephemeral device
            be preserved when rebuilding the instance. Defaults to False.
        :param name: Something to name the server.
        :param meta: A dict of arbitrary key/value metadata to store for this
                     server. Both keys and values must be <=255 characters.
        :param files: A dict of files to overwrite on the server upon boot.
                      Keys are file names (i.e. ``/etc/passwd``) and values
                      are the file contents (either as a string or as a
                      file-like object). A maximum of five entries is allowed,
                      and each file must be 10k or less.
        """
        body = {'imageRef': base.getid(image)}
        if password is not None:
            body['adminPass'] = password
        if disk_config is not None:
            body['OS-DCF:diskConfig'] = disk_config
        if preserve_ephemeral is not False:
            body['preserve_ephemeral'] = True
        if name is not None:
            body['name'] = name
        if meta:
            body['metadata'] = meta
        if files:
            personality = body['personality'] = []
            for filepath, file_or_string in sorted(files.items(),
                                                   key=lambda x: x[0]):
                if hasattr(file_or_string, 'read'):
                    data = file_or_string.read()
                else:
                    data = file_or_string

cont = base64.b64encode(data.encode('utf-8')).decode('utf-8')
                personality.append({
                    'path': filepath,
                    'contents': cont,
                })

_resp, body = self._action('rebuild', server, body, **kwargs)
        return Server(self, body['server'])

def migrate(self, server):
        """
        Migrate a server to a new host.

:param server: The :class:`Server` (or its ID).
        """
        self._action('migrate', server)

def resize(self, server, flavor, disk_config=None, **kwargs):
        """
        Resize a server's resources.

:param server: The :class:`Server` (or its ID) to share onto.
        :param flavor: the :class:`Flavor` (or its ID) to resize to.
        :param disk_config: partitioning mode to use on the rebuilt server.
                            Valid values are 'AUTO' or 'MANUAL'

self._action('resize', server, info=info, **kwargs)

def confirm_resize(self, server):
        """
        Confirm that the resize worked, thus removing the original server.

:param server: The :class:`Server` (or its ID) to share onto.
        """
        self._action('confirmResize', server)

def revert_resize(self, server):
        """
        Revert a previous resize, switching back to the old server.

:param server: The :class:`Server` (or its ID) to share onto.
        """
        self._action('revertResize', server)

def create_image(self, server, image_name, metadata=None):
        """
        Snapshot a server.

:param server: The :class:`Server` (or its ID) to share onto.
        :param image_name: Name to give the snapshot image
        :param metadata: Metadata to give newly-created image entity
        """
        body = {'name': image_name, 'metadata': metadata or {}}
        resp = self._action('createImage', server, body)[0]
        location = resp.headers['location']
        image_uuid = location.split('/')[-1]
        return image_uuid

def backup(self, server, backup_name, backup_type, rotation):
        """
        Backup a server instance.

:param server: The :class:`Server` (or its ID) to share onto.
        :param backup_name: Name of the backup image
        :param backup_type: The backup type, like 'daily' or 'weekly'
        :param rotation: Int parameter representing how many backups to
                        keep around.
        """
        body = {'name': backup_name,
                'backup_type': backup_type,
                'rotation': rotation}
        self._action('createBackup', server, body)

def set_meta(self, server, metadata):
        """
        Set a servers metadata
        :param server: The :class:`Server` to add metadata to
        :param metadata: A dict of metadata to add to the server
        """
        body = {'metadata': metadata}
        return self._create("/servers/%s/metadata" % base.getid(server),
                            body, "metadata")

def set_meta_item(self, server, key, value):
        """
        Updates an item of server metadata
        :param server: The :class:`Server` to add metadata to
        :param key: metadata key to update
        :param value: string value
        """
        body = {'meta': {key: value}}
        return self._update("/servers/%s/metadata/%s" %
                            (base.getid(server), key), body)

def get_console_output(self, server, length=None):
        """
        Get text console log output from Server.

:param server: The :class:`Server` (or its ID) whose console output
                        you would like to retrieve.
        :param length: The number of tail loglines you would like to retrieve.
        """
        return self._action('os-getConsoleOutput',
                            server,
                            {'length': length})[1]['output']

def delete_meta(self, server, keys):
        """
        Delete metadata from an server
        :param server: The :class:`Server` to add metadata to
        :param keys: A list of metadata keys to delete from the server
        """
        for k in keys:
            self._delete("/servers/%s/metadata/%s" % (base.getid(server), k))

def live_migrate(self, server, host, block_migration, disk_over_commit):
        """
        Migrates a running instance to a new machine.

:param server: instance id which comes from nova list.
        :param host: destination host name.
        :param block_migration: if True, do block_migration.
        :param disk_over_commit: if True, Allow overcommit.

"""
        self._action('os-migrateLive', server,
                     {'host': host,
                      'block_migration': block_migration,
                      'disk_over_commit': disk_over_commit})

def reset_state(self, server, state='error'):
        """
        Reset the state of an instance to active or error.

:param server: ID of the instance to reset the state of.
        :param state: Desired state; either 'active' or 'error'.
                      Defaults to 'error'.
        """
        self._action('os-resetState', server, dict(state=state))

def reset_network(self, server):
        """
        Reset network of an instance.
        """
        self._action('resetNetwork', server)

def add_security_group(self, server, security_group):
        """
        Add a Security Group to an instance

:param server: ID of the instance.
        :param security_group: The name of security group to add.

"""
        self._action('addSecurityGroup', server, {'name': security_group})

def remove_security_group(self, server, security_group):
        """
        Add a Security Group to an instance

:param server: ID of the instance.
        :param security_group: The name of security group to remove.

"""
        self._action('removeSecurityGroup', server, {'name': security_group})

def list_security_group(self, server):
        """
        List Security Group(s) of an instance

:param server: ID of the instance.

"""
        return self._list('/servers/%s/os-security-groups' %
                          base.getid(server), 'security_groups',
                          security_groups.SecurityGroup)

def evacuate(self, server, host=None, on_shared_storage=True,
                 password=None):
        """
        Evacuate a server instance.

:param server: The :class:`Server` (or its ID) to share onto.
        :param host: Name of the target host.
        :param on_shared_storage: Specifies whether instance files located
                        on shared storage
        :param password: string to set as password on the evacuated server.
        """

body = {'onSharedStorage': on_shared_storage}
        if host is not None:
            body['host'] = host

if password is not None:
            body['adminPass'] = password

return self._action('evacuate', server, body)

def interface_list(self, server):
        """
        List attached network interfaces

:param server: The :class:`Server` (or its ID) to query.
        """
        return self._list('/servers/%s/os-interface' % base.getid(server),
                          'interfaceAttachments')

def interface_attach(self, server, port_id, net_id, fixed_ip):
        """
        Attach a network_interface to an instance.

:param server: The :class:`Server` (or its ID) to attach to.
        :param port_id: The port to attach.
        """

body = {'interfaceAttachment': {}}
        if port_id:
            body['interfaceAttachment']['port_id'] = port_id
        if net_id:
            body['interfaceAttachment']['net_id'] = net_id
        if fixed_ip:
            body['interfaceAttachment']['fixed_ips'] = [
                {'ip_address': fixed_ip}]

return self._create('/servers/%s/os-interface' % base.getid(server),
                            body, 'interfaceAttachment')

def interface_detach(self, server, port_id):
        """
        Detach a network_interface from an instance.

:param server: The :class:`Server` (or its ID) to detach from.
        :param port_id: The port to detach.
        """
        self._delete('/servers/%s/os-interface/%s' % (base.getid(server),
                                                      port_id))

def _action(self, action, server, info=None, **kwargs):
        """
        Perform a server "action" -- reboot/rebuild/resize/etc.
        """
        body = {action: info}
        self.run_hooks('modify_body_for_action', body, **kwargs)
        url = '/servers/%s/action' % base.getid(server)
        return self.api.client.post(url, body=body)

cmd: