303 lines
9.6 KiB
Python
303 lines
9.6 KiB
Python
# Copyright 2012-2013 OpenStack Foundation
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
"""Volume v1 Snapshot action implementations"""
|
|
|
|
import copy
|
|
import logging
|
|
|
|
from osc_lib.cli import parseractions
|
|
from osc_lib.command import command
|
|
from osc_lib import exceptions
|
|
from osc_lib import utils
|
|
import six
|
|
|
|
from openstackclient.i18n import _
|
|
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
|
|
class CreateSnapshot(command.ShowOne):
|
|
"""Create new snapshot"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(CreateSnapshot, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'volume',
|
|
metavar='<volume>',
|
|
help=_('Volume to snapshot (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--name',
|
|
metavar='<name>',
|
|
help=_('Name of the snapshot'),
|
|
)
|
|
parser.add_argument(
|
|
'--description',
|
|
metavar='<description>',
|
|
help=_('Description of the snapshot'),
|
|
)
|
|
parser.add_argument(
|
|
'--force',
|
|
dest='force',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('Create a snapshot attached to an instance. '
|
|
'Default is False'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
volume_id = utils.find_resource(volume_client.volumes,
|
|
parsed_args.volume).id
|
|
snapshot = volume_client.volume_snapshots.create(
|
|
volume_id,
|
|
parsed_args.force,
|
|
parsed_args.name,
|
|
parsed_args.description
|
|
)
|
|
|
|
snapshot._info.update(
|
|
{'properties': utils.format_dict(snapshot._info.pop('metadata'))}
|
|
)
|
|
|
|
return zip(*sorted(six.iteritems(snapshot._info)))
|
|
|
|
|
|
class DeleteSnapshot(command.Command):
|
|
"""Delete snapshot(s)"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(DeleteSnapshot, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'snapshots',
|
|
metavar='<snapshot>',
|
|
nargs="+",
|
|
help=_('Snapshot(s) to delete (name or ID)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
result = 0
|
|
|
|
for i in parsed_args.snapshots:
|
|
try:
|
|
snapshot_id = utils.find_resource(
|
|
volume_client.volume_snapshots, i).id
|
|
volume_client.volume_snapshots.delete(snapshot_id)
|
|
except Exception as e:
|
|
result += 1
|
|
LOG.error(_("Failed to delete snapshot with "
|
|
"name or ID '%(snapshot)s': %(e)s"),
|
|
{'snapshot': i, 'e': e})
|
|
|
|
if result > 0:
|
|
total = len(parsed_args.snapshots)
|
|
msg = (_("%(result)s of %(total)s snapshots failed "
|
|
"to delete.") % {'result': result, 'total': total})
|
|
raise exceptions.CommandError(msg)
|
|
|
|
|
|
class ListSnapshot(command.Lister):
|
|
"""List snapshots"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ListSnapshot, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'--all-projects',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('Include all projects (admin only)'),
|
|
)
|
|
parser.add_argument(
|
|
'--long',
|
|
action='store_true',
|
|
default=False,
|
|
help=_('List additional fields in output'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
|
|
def _format_volume_id(volume_id):
|
|
"""Return a volume name if available
|
|
|
|
:param volume_id: a volume ID
|
|
:rtype: either the volume ID or name
|
|
"""
|
|
|
|
volume = volume_id
|
|
if volume_id in volume_cache.keys():
|
|
volume = volume_cache[volume_id].display_name
|
|
return volume
|
|
|
|
if parsed_args.long:
|
|
columns = ['ID', 'Display Name', 'Display Description', 'Status',
|
|
'Size', 'Created At', 'Volume ID', 'Metadata']
|
|
column_headers = copy.deepcopy(columns)
|
|
column_headers[6] = 'Volume'
|
|
column_headers[7] = 'Properties'
|
|
else:
|
|
columns = ['ID', 'Display Name', 'Display Description', 'Status',
|
|
'Size']
|
|
column_headers = copy.deepcopy(columns)
|
|
|
|
# Always update Name and Description
|
|
column_headers[1] = 'Name'
|
|
column_headers[2] = 'Description'
|
|
|
|
# Cache the volume list
|
|
volume_cache = {}
|
|
try:
|
|
for s in self.app.client_manager.volume.volumes.list():
|
|
volume_cache[s.id] = s
|
|
except Exception:
|
|
# Just forget it if there's any trouble
|
|
pass
|
|
|
|
search_opts = {
|
|
'all_tenants': parsed_args.all_projects,
|
|
}
|
|
|
|
data = self.app.client_manager.volume.volume_snapshots.list(
|
|
search_opts=search_opts)
|
|
return (column_headers,
|
|
(utils.get_item_properties(
|
|
s, columns,
|
|
formatters={'Metadata': utils.format_dict,
|
|
'Volume ID': _format_volume_id},
|
|
) for s in data))
|
|
|
|
|
|
class SetSnapshot(command.Command):
|
|
"""Set snapshot properties"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(SetSnapshot, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'snapshot',
|
|
metavar='<snapshot>',
|
|
help=_('Snapshot to modify (name or ID)')
|
|
)
|
|
parser.add_argument(
|
|
'--name',
|
|
metavar='<name>',
|
|
help=_('New snapshot name')
|
|
)
|
|
parser.add_argument(
|
|
'--description',
|
|
metavar='<description>',
|
|
help=_('New snapshot description')
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key=value>',
|
|
action=parseractions.KeyValueAction,
|
|
help=_('Property to add/change for this snapshot '
|
|
'(repeat option to set multiple properties)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
snapshot = utils.find_resource(volume_client.volume_snapshots,
|
|
parsed_args.snapshot)
|
|
|
|
result = 0
|
|
if parsed_args.property:
|
|
try:
|
|
volume_client.volume_snapshots.set_metadata(
|
|
snapshot.id, parsed_args.property)
|
|
except Exception as e:
|
|
LOG.error(_("Failed to set snapshot property: %s"), e)
|
|
result += 1
|
|
|
|
kwargs = {}
|
|
if parsed_args.name:
|
|
kwargs['display_name'] = parsed_args.name
|
|
if parsed_args.description:
|
|
kwargs['display_description'] = parsed_args.description
|
|
if kwargs:
|
|
try:
|
|
snapshot.update(**kwargs)
|
|
except Exception as e:
|
|
LOG.error(_("Failed to update snapshot display name "
|
|
"or display description: %s"), e)
|
|
result += 1
|
|
|
|
if result > 0:
|
|
raise exceptions.CommandError(_("One or more of the "
|
|
"set operations failed"))
|
|
|
|
|
|
class ShowSnapshot(command.ShowOne):
|
|
"""Display snapshot details"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(ShowSnapshot, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'snapshot',
|
|
metavar='<snapshot>',
|
|
help=_('Snapshot to display (name or ID)')
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
snapshot = utils.find_resource(volume_client.volume_snapshots,
|
|
parsed_args.snapshot)
|
|
|
|
snapshot._info.update(
|
|
{'properties': utils.format_dict(snapshot._info.pop('metadata'))}
|
|
)
|
|
|
|
return zip(*sorted(six.iteritems(snapshot._info)))
|
|
|
|
|
|
class UnsetSnapshot(command.Command):
|
|
"""Unset snapshot properties"""
|
|
|
|
def get_parser(self, prog_name):
|
|
parser = super(UnsetSnapshot, self).get_parser(prog_name)
|
|
parser.add_argument(
|
|
'snapshot',
|
|
metavar='<snapshot>',
|
|
help=_('Snapshot to modify (name or ID)'),
|
|
)
|
|
parser.add_argument(
|
|
'--property',
|
|
metavar='<key>',
|
|
action='append',
|
|
default=[],
|
|
required=True,
|
|
help=_('Property to remove from snapshot '
|
|
'(repeat option to remove multiple properties)'),
|
|
)
|
|
return parser
|
|
|
|
def take_action(self, parsed_args):
|
|
volume_client = self.app.client_manager.volume
|
|
snapshot = utils.find_resource(
|
|
volume_client.volume_snapshots, parsed_args.snapshot)
|
|
|
|
if parsed_args.property:
|
|
volume_client.volume_snapshots.delete_metadata(
|
|
snapshot.id,
|
|
parsed_args.property,
|
|
)
|