# Copyright 2012-2013 OpenStack, LLC. # # 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 import six from cliff import command from cliff import lister from cliff import show from openstackclient.common import parseractions from openstackclient.common import utils class CreateSnapshot(show.ShowOne): """Create new snapshot""" log = logging.getLogger(__name__ + '.CreateSnapshot') def get_parser(self, prog_name): parser = super(CreateSnapshot, self).get_parser(prog_name) parser.add_argument( 'volume', metavar='', help='Volume to snapshot (name or ID)', ) parser.add_argument( '--name', metavar='', required=True, help='Name of the snapshot', ) parser.add_argument( '--description', metavar='', 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): self.log.debug('take_action(%s)', 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)""" log = logging.getLogger(__name__ + '.DeleteSnapshot') def get_parser(self, prog_name): parser = super(DeleteSnapshot, self).get_parser(prog_name) parser.add_argument( 'snapshots', metavar='', nargs="+", help='Snapshot(s) to delete (name or ID)', ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', parsed_args) volume_client = self.app.client_manager.volume for snapshot in parsed_args.snapshots: snapshot_id = utils.find_resource(volume_client.volume_snapshots, snapshot).id volume_client.volume_snapshots.delete(snapshot_id) return class ListSnapshot(lister.Lister): """List snapshots""" log = logging.getLogger(__name__ + '.ListSnapshot') def get_parser(self, prog_name): parser = super(ListSnapshot, self).get_parser(prog_name) parser.add_argument( '--long', action='store_true', default=False, help='List additional fields in output', ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', 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 data = self.app.client_manager.volume.volume_snapshots.list() 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""" log = logging.getLogger(__name__ + '.SetSnapshot') def get_parser(self, prog_name): parser = super(SetSnapshot, self).get_parser(prog_name) parser.add_argument( 'snapshot', metavar='', help='Snapshot to modify (name or ID)') parser.add_argument( '--name', metavar='', help='New snapshot name') parser.add_argument( '--description', metavar='', help='New snapshot description') parser.add_argument( '--property', metavar='', 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): self.log.debug('take_action(%s)', 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.set_metadata(snapshot.id, parsed_args.property) kwargs = {} if parsed_args.name: kwargs['display_name'] = parsed_args.name if parsed_args.description: kwargs['display_description'] = parsed_args.description if not kwargs and not parsed_args.property: self.app.log.error("No changes requested\n") return snapshot.update(**kwargs) return class ShowSnapshot(show.ShowOne): """Display snapshot details""" log = logging.getLogger(__name__ + '.ShowSnapshot') def get_parser(self, prog_name): parser = super(ShowSnapshot, self).get_parser(prog_name) parser.add_argument( 'snapshot', metavar='', help='Snapshot to display (name or ID)') return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', 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""" log = logging.getLogger(__name__ + '.UnsetSnapshot') def get_parser(self, prog_name): parser = super(UnsetSnapshot, self).get_parser(prog_name) parser.add_argument( 'snapshot', metavar='', help='Snapshot to modify (name or ID)', ) parser.add_argument( '--property', metavar='', action='append', default=[], help='Property to remove from snapshot ' '(repeat to remove multiple values)', required=True, ) return parser def take_action(self, parsed_args): self.log.debug('take_action(%s)', 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, ) else: self.app.log.error("No changes requested\n") return