python-openstackclient/openstackclient/volume/v2/volume_type.py

318 lines
11 KiB
Python

#
# 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 v2 Type action implementations"""
import six
from openstackclient.common import command
from openstackclient.common import exceptions
from openstackclient.common import parseractions
from openstackclient.common import utils
from openstackclient.identity import common as identity_common
class CreateVolumeType(command.ShowOne):
"""Create new volume type"""
def get_parser(self, prog_name):
parser = super(CreateVolumeType, self).get_parser(prog_name)
parser.add_argument(
"name",
metavar="<name>",
help="Volume type name",
)
parser.add_argument(
"--description",
metavar="<description>",
help="Volume type description",
)
public_group = parser.add_mutually_exclusive_group()
public_group.add_argument(
"--public",
dest="public",
action="store_true",
default=False,
help="Volume type is accessible to the public",
)
public_group.add_argument(
"--private",
dest="private",
action="store_true",
default=False,
help="Volume type is not accessible to the public",
)
parser.add_argument(
'--property',
metavar='<key=value>',
action=parseractions.KeyValueAction,
help='Set a property on this volume type '
'(repeat option to set multiple properties)',
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
kwargs = {}
if parsed_args.public:
kwargs['is_public'] = True
if parsed_args.private:
kwargs['is_public'] = False
volume_type = volume_client.volume_types.create(
parsed_args.name,
description=parsed_args.description,
**kwargs
)
volume_type._info.pop('extra_specs')
if parsed_args.property:
result = volume_type.set_keys(parsed_args.property)
volume_type._info.update({'properties': utils.format_dict(result)})
return zip(*sorted(six.iteritems(volume_type._info)))
class DeleteVolumeType(command.Command):
"""Delete volume type"""
def get_parser(self, prog_name):
parser = super(DeleteVolumeType, self).get_parser(prog_name)
parser.add_argument(
"volume_type",
metavar="<volume-type>",
help="Volume type to delete (name or ID)"
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
volume_type = utils.find_resource(
volume_client.volume_types, parsed_args.volume_type)
volume_client.volume_types.delete(volume_type.id)
class ListVolumeType(command.Lister):
"""List volume types"""
def get_parser(self, prog_name):
parser = super(ListVolumeType, 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):
if parsed_args.long:
columns = ['ID', 'Name', 'Description', 'Extra Specs']
column_headers = ['ID', 'Name', 'Description', 'Properties']
else:
columns = ['ID', 'Name']
column_headers = columns
data = self.app.client_manager.volume.volume_types.list()
return (column_headers,
(utils.get_item_properties(
s, columns,
formatters={'Extra Specs': utils.format_dict},
) for s in data))
class SetVolumeType(command.Command):
"""Set volume type properties"""
def get_parser(self, prog_name):
parser = super(SetVolumeType, self).get_parser(prog_name)
parser.add_argument(
'volume_type',
metavar='<volume-type>',
help='Volume type to modify (name or ID)',
)
parser.add_argument(
'--name',
metavar='<name>',
help='Set volume type name',
)
parser.add_argument(
'--description',
metavar='<name>',
help='Set volume type description',
)
parser.add_argument(
'--property',
metavar='<key=value>',
action=parseractions.KeyValueAction,
help='Set a property on this volume type '
'(repeat option to set multiple properties)',
)
parser.add_argument(
'--project',
metavar='<project>',
help='Set volume type access to project (name or ID) (admin only)',
)
identity_common.add_project_domain_option_to_parser(parser)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
identity_client = self.app.client_manager.identity
volume_type = utils.find_resource(
volume_client.volume_types, parsed_args.volume_type)
if (not parsed_args.name
and not parsed_args.description
and not parsed_args.property
and not parsed_args.project):
self.app.log.error("No changes requested\n")
return
result = 0
kwargs = {}
if parsed_args.name:
kwargs['name'] = parsed_args.name
if parsed_args.description:
kwargs['description'] = parsed_args.description
if kwargs:
try:
volume_client.volume_types.update(
volume_type.id,
**kwargs
)
except Exception as e:
self.app.log.error("Failed to update volume type name or"
" description: " + str(e))
result += 1
if parsed_args.property:
try:
volume_type.set_keys(parsed_args.property)
except Exception as e:
self.app.log.error("Failed to set volume type property: " +
str(e))
result += 1
if parsed_args.project:
project_info = None
try:
project_info = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain)
volume_client.volume_type_access.add_project_access(
volume_type.id, project_info.id)
except Exception as e:
self.app.log.error("Failed to set volume type access to"
" project: " + str(e))
result += 1
if result > 0:
raise exceptions.CommandError("Command Failed: One or more of the"
" operations failed")
class ShowVolumeType(command.ShowOne):
"""Display volume type details"""
def get_parser(self, prog_name):
parser = super(ShowVolumeType, self).get_parser(prog_name)
parser.add_argument(
"volume_type",
metavar="<volume-type>",
help="Volume type to display (name or ID)"
)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
volume_type = utils.find_resource(
volume_client.volume_types, parsed_args.volume_type)
properties = utils.format_dict(volume_type._info.pop('extra_specs'))
volume_type._info.update({'properties': properties})
return zip(*sorted(six.iteritems(volume_type._info)))
class UnsetVolumeType(command.Command):
"""Unset volume type properties"""
def get_parser(self, prog_name):
parser = super(UnsetVolumeType, self).get_parser(prog_name)
parser.add_argument(
'volume_type',
metavar='<volume-type>',
help='Volume type to modify (name or ID)',
)
parser.add_argument(
'--property',
metavar='<key>',
help='Remove a property from this volume type '
'(repeat option to remove multiple properties)',
)
parser.add_argument(
'--project',
metavar='<project>',
help='Removes volume type access to project (name or ID) '
' (admin only)',
)
identity_common.add_project_domain_option_to_parser(parser)
return parser
def take_action(self, parsed_args):
volume_client = self.app.client_manager.volume
identity_client = self.app.client_manager.identity
volume_type = utils.find_resource(
volume_client.volume_types,
parsed_args.volume_type,
)
if (not parsed_args.property
and not parsed_args.project):
self.app.log.error("No changes requested\n")
return
result = 0
if parsed_args.property:
try:
volume_type.unset_keys(parsed_args.property)
except Exception as e:
self.app.log.error("Failed to unset volume type property: " +
str(e))
result += 1
if parsed_args.project:
project_info = None
try:
project_info = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain)
volume_client.volume_type_access.remove_project_access(
volume_type.id, project_info.id)
except Exception as e:
self.app.log.error("Failed to remove volume type access from"
" project: " + str(e))
result += 1
if result > 0:
raise exceptions.CommandError("Command Failed: One or more of the"
" operations failed")