python-openstackclient 6.3.0__py3-none-any.whl → 6.5.0__py3-none-any.whl

openstackclient/volume/v2/volume_type.py

@@ -17,6 +17,7 @@
 import functools
 import logging
 
+from cinderclient import api_versions
 from cliff import columns as cliff_columns
 from osc_lib.cli import format_columns
 from osc_lib.cli import parseractions
@@ -139,19 +140,61 @@ class CreateVolumeType(command.ShowOne):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Set a property on this volume type '
                 '(repeat option to set multiple properties)'
             ),
         )
+        parser.add_argument(
+            '--multiattach',
+            action='store_true',
+            default=False,
+            help=_(
+                "Enable multi-attach for this volume type "
+                "(this is an alias for '--property multiattach=<is> True') "
+                "(requires driver support)"
+            ),
+        )
+        parser.add_argument(
+            '--cacheable',
+            action='store_true',
+            default=False,
+            help=_(
+                "Enable caching for this volume type "
+                "(this is an alias for '--property cacheable=<is> True') "
+                "(requires driver support)"
+            ),
+        )
+        parser.add_argument(
+            '--replicated',
+            action='store_true',
+            default=False,
+            help=_(
+                "Enabled replication for this volume type "
+                "(this is an alias for '--property replication_enabled=<is> True') "  # noqa: E501
+                "(requires driver support)"
+            ),
+        )
+        parser.add_argument(
+            '--availability-zone',
+            action='append',
+            dest='availability_zones',
+            help=_(
+                "Set an availability zone for this volume type "
+                "(this is an alias for '--property RESKEY:availability_zones:<az>') "  # noqa: E501
+                "(repeat option to set multiple availability zones)"
+            ),
+        )
         parser.add_argument(
             '--project',
             metavar='<project>',
             help=_(
                 "Allow <project> to access private type (name or ID) "
-                "(Must be used with --private option)"
+                "(must be used with --private option)"
             ),
         )
+        identity_common.add_project_domain_option_to_parser(parser)
         # TODO(Huanxuan Ao): Add choices for each "--encryption-*" option.
         parser.add_argument(
             '--encryption-provider',
@@ -159,8 +202,8 @@ class CreateVolumeType(command.ShowOne):
             help=_(
                 'Set the encryption provider format for '
                 'this volume type (e.g "luks" or "plain") (admin only) '
-                '(This option is required when setting encryption type '
-                'of a volume. Consider using other encryption options '
+                '(this option is required when setting encryption type '
+                'of a volume; consider using other encryption options '
                 'such as: "--encryption-cipher", "--encryption-key-size" '
                 'and "--encryption-control-location")'
             ),
@@ -196,7 +239,6 @@ class CreateVolumeType(command.ShowOne):
                 '"--encryption-provider")'
             ),
         )
-        identity_common.add_project_domain_option_to_parser(parser)
         return parser
 
     def take_action(self, parsed_args):
@@ -208,11 +250,14 @@ class CreateVolumeType(command.ShowOne):
             raise exceptions.CommandError(msg)
 
         kwargs = {}
+
         if parsed_args.is_public is not None:
             kwargs['is_public'] = parsed_args.is_public
 
         volume_type = volume_client.volume_types.create(
-            parsed_args.name, description=parsed_args.description, **kwargs
+            parsed_args.name,
+            description=parsed_args.description,
+            **kwargs,
         )
         volume_type._info.pop('extra_specs')
 
@@ -232,11 +277,26 @@ class CreateVolumeType(command.ShowOne):
                     "type: %(e)s"
                 )
                 LOG.error(msg % {'project': parsed_args.project, 'e': e})
-        if parsed_args.property:
-            result = volume_type.set_keys(parsed_args.property)
+
+        properties = {}
+        if parsed_args.properties:
+            properties.update(parsed_args.properties)
+        if parsed_args.multiattach:
+            properties['multiattach'] = '<is> True'
+        if parsed_args.cacheable:
+            properties['cacheable'] = '<is> True'
+        if parsed_args.replicated:
+            properties['replication_enabled'] = '<is> True'
+        if parsed_args.availability_zones:
+            properties['RESKEY:availability_zones'] = ','.join(
+                parsed_args.availability_zones
+            )
+        if properties:
+            result = volume_type.set_keys(properties)
             volume_type._info.update(
                 {'properties': format_columns.DictColumn(result)}
             )
+
         if (
             parsed_args.encryption_provider
             or parsed_args.encryption_cipher
@@ -261,6 +321,7 @@ class CreateVolumeType(command.ShowOne):
             volume_type._info.update(
                 {'encryption': format_columns.DictColumn(encryption._info)}
             )
+
         volume_type._info.pop("os-volume-type-access:is_public", None)
 
         return zip(*sorted(volume_type._info.items()))
@@ -348,6 +409,59 @@ class ListVolumeType(command.Lister):
                 "(admin only)"
             ),
         )
+        parser.add_argument(
+            '--property',
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            dest='properties',
+            help=_(
+                'Filter by a property on the volume types '
+                '(repeat option to filter by multiple properties) '
+                '(admin only except for user-visible extra specs) '
+                '(supported by --os-volume-api-version 3.52 or above)'
+            ),
+        )
+        parser.add_argument(
+            '--multiattach',
+            action='store_true',
+            default=False,
+            help=_(
+                "List only volume types with multi-attach enabled "
+                "(this is an alias for '--property multiattach=<is> True') "
+                "(supported by --os-volume-api-version 3.52 or above)"
+            ),
+        )
+        parser.add_argument(
+            '--cacheable',
+            action='store_true',
+            default=False,
+            help=_(
+                "List only volume types with caching enabled "
+                "(this is an alias for '--property cacheable=<is> True') "
+                "(admin only) "
+                "(supported by --os-volume-api-version 3.52 or above)"
+            ),
+        )
+        parser.add_argument(
+            '--replicated',
+            action='store_true',
+            default=False,
+            help=_(
+                "List only volume types with replication enabled "
+                "(this is an alias for '--property replication_enabled=<is> True') "  # noqa: E501
+                "(supported by --os-volume-api-version 3.52 or above)"
+            ),
+        )
+        parser.add_argument(
+            '--availability-zone',
+            action='append',
+            dest='availability_zones',
+            help=_(
+                "List only volume types with this availability configured "
+                "(this is an alias for '--property RESKEY:availability_zones:<az>') "  # noqa: E501
+                "(repeat option to filter on multiple availability zones)"
+            ),
+        )
         return parser
 
     def take_action(self, parsed_args):
@@ -375,8 +489,34 @@ class ListVolumeType(command.Lister):
         if parsed_args.default:
             data = [volume_client.volume_types.default()]
         else:
+            search_opts = {}
+            properties = {}
+            if parsed_args.properties:
+                properties.update(parsed_args.properties)
+            if parsed_args.multiattach:
+                properties['multiattach'] = '<is> True'
+            if parsed_args.cacheable:
+                properties['cacheable'] = '<is> True'
+            if parsed_args.replicated:
+                properties['replication_enabled'] = '<is> True'
+            if parsed_args.availability_zones:
+                properties['RESKEY:availability_zones'] = ','.join(
+                    parsed_args.availability_zones
+                )
+            if properties:
+                if volume_client.api_version < api_versions.APIVersion('3.52'):
+                    msg = _(
+                        "--os-volume-api-version 3.52 or greater is required "
+                        "to use the '--property' option or any of the alias "
+                        "options"
+                    )
+                    raise exceptions.CommandError(msg)
+
+                search_opts['extra_specs'] = properties
+
             data = volume_client.volume_types.list(
-                is_public=parsed_args.is_public
+                search_opts=search_opts,
+                is_public=parsed_args.is_public,
             )
 
         formatters = {'Extra Specs': format_columns.DictColumn}
@@ -445,11 +585,52 @@ class SetVolumeType(command.Command):
             '--property',
             metavar='<key=value>',
             action=parseractions.KeyValueAction,
+            dest='properties',
             help=_(
                 'Set a property on this volume type '
                 '(repeat option to set multiple properties)'
             ),
         )
+        parser.add_argument(
+            '--multiattach',
+            action='store_true',
+            default=False,
+            help=_(
+                "Enable multi-attach for this volume type "
+                "(this is an alias for '--property multiattach=<is> True') "
+                "(requires driver support)"
+            ),
+        )
+        parser.add_argument(
+            '--cacheable',
+            action='store_true',
+            default=False,
+            help=_(
+                "Enable caching for this volume type "
+                "(this is an alias for '--property cacheable=<is> True') "
+                "(requires driver support)"
+            ),
+        )
+        parser.add_argument(
+            '--replicated',
+            action='store_true',
+            default=False,
+            help=_(
+                "Enabled replication for this volume type "
+                "(this is an alias for '--property replication_enabled=<is> True') "  # noqa: E501
+                "(requires driver support)"
+            ),
+        )
+        parser.add_argument(
+            '--availability-zone',
+            action='append',
+            dest='availability_zones',
+            help=_(
+                "Set an availability zone for this volume type "
+                "(this is an alias for '--property RESKEY:availability_zones:<az>') "  # noqa: E501
+                "(repeat option to set multiple availability zones)"
+            ),
+        )
         parser.add_argument(
             '--project',
             metavar='<project>',
@@ -555,11 +736,26 @@ class SetVolumeType(command.Command):
                 )
                 result += 1
 
-        if parsed_args.property:
+        properties = {}
+
+        properties = {}
+        if parsed_args.properties:
+            properties.update(parsed_args.properties)
+        if parsed_args.multiattach:
+            properties['multiattach'] = '<is> True'
+        if parsed_args.cacheable:
+            properties['cacheable'] = '<is> True'
+        if parsed_args.replicated:
+            properties['replication_enabled'] = '<is> True'
+        if parsed_args.availability_zones:
+            properties['RESKEY:availability_zones'] = ','.join(
+                parsed_args.availability_zones
+            )
+        if properties:
             try:
-                volume_type.set_keys(parsed_args.property)
+                volume_type.set_keys(properties)
             except Exception as e:
-                LOG.error(_("Failed to set volume type property: %s"), e)
+                LOG.error(_("Failed to set volume type properties: %s"), e)
                 result += 1
 
         if parsed_args.project:
@@ -689,6 +885,7 @@ class UnsetVolumeType(command.Command):
             '--property',
             metavar='<key>',
             action='append',
+            dest='properties',
             help=_(
                 'Remove a property from this volume type '
                 '(repeat option to remove multiple properties)'
@@ -723,11 +920,11 @@ class UnsetVolumeType(command.Command):
         )
 
         result = 0
-        if parsed_args.property:
+        if parsed_args.properties:
             try:
-                volume_type.unset_keys(parsed_args.property)
+                volume_type.unset_keys(parsed_args.properties)
             except Exception as e:
-                LOG.error(_("Failed to unset volume type property: %s"), e)
+                LOG.error(_("Failed to unset volume type properties: %s"), e)
                 result += 1
 
         if parsed_args.project:

openstackclient/volume/v3/block_storage_manage.py

@@ -13,11 +13,12 @@
 
 """Block Storage Volume/Snapshot Management implementations"""
 
+import argparse
+
 from cinderclient import api_versions
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
-from oslo_utils import strutils
 
 from openstackclient.i18n import _
 
@@ -52,11 +53,18 @@ class BlockStorageManageVolumes(command.Lister):
                 '(supported by --os-volume-api-version 3.17 or later)'
             ),
         )
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help=_('List additional fields in output'),
+        )
+        # TODO(stephenfin): Remove this in a future major version bump
         parser.add_argument(
             '--detailed',
             metavar='<detailed>',
-            default=True,
-            help=_('Returns detailed information (Default=True).'),
+            default=None,
+            help=argparse.SUPPRESS,
         )
         parser.add_argument(
             '--marker',
@@ -121,8 +129,30 @@ class BlockStorageManageVolumes(command.Lister):
                 )
                 raise exceptions.CommandError(msg)
 
-        detailed = strutils.bool_from_string(parsed_args.detailed)
-        cluster = getattr(parsed_args, 'cluster', None)
+        detailed = parsed_args.long
+        if parsed_args.detailed is not None:
+            detailed = parsed_args.detailed.lower().strip() in {
+                '1',
+                't',
+                'true',
+                'on',
+                'y',
+                'yes',
+            }
+            if detailed:
+                # if the user requested e.g. '--detailed true' then they should
+                # not request '--long'
+                msg = _(
+                    "The --detailed option has been deprecated. "
+                    "Use --long instead."
+                )
+                self.log.warning(msg)
+            else:
+                # if the user requested e.g. '--detailed false' then they
+                # should simply stop requesting this since the default has
+                # changed
+                msg = _("The --detailed option has been deprecated. Unset it.")
+                self.log.warning(msg)
 
         columns = [
             'reference',
@@ -145,7 +175,7 @@ class BlockStorageManageVolumes(command.Lister):
             limit=parsed_args.limit,
             offset=parsed_args.offset,
             sort=parsed_args.sort,
-            cluster=cluster,
+            cluster=parsed_args.cluster,
         )
 
         return (
@@ -187,11 +217,18 @@ class BlockStorageManageSnapshots(command.Lister):
                 '(supported by --os-volume-api-version 3.17 or later)'
             ),
         )
+        parser.add_argument(
+            '--long',
+            action='store_true',
+            default=False,
+            help=_('List additional fields in output'),
+        )
+        # TODO(stephenfin): Remove this in a future major version bump
         parser.add_argument(
             '--detailed',
             metavar='<detailed>',
-            default=True,
-            help=_('Returns detailed information (Default=True).'),
+            default=None,
+            help=argparse.SUPPRESS,
         )
         parser.add_argument(
             '--marker',
@@ -258,8 +295,32 @@ class BlockStorageManageSnapshots(command.Lister):
                 )
                 raise exceptions.CommandError(msg)
 
-        detailed = strutils.bool_from_string(parsed_args.detailed)
-        cluster = getattr(parsed_args, 'cluster', None)
+        detailed = parsed_args.long
+        if parsed_args.detailed is not None:
+            detailed = parsed_args.detailed.lower().strip() in {
+                '1',
+                't',
+                'true',
+                'on',
+                'y',
+                'yes',
+            }
+            if detailed:
+                # if the user requested e.g. '--detailed true' then they should
+                # not request '--long'
+                msg = _(
+                    "The --detailed option has been deprecated. "
+                    "Use --long instead."
+                )
+                self.log.warning(msg)
+            else:
+                # if the user requested e.g. '--detailed false' then they
+                # should simply stop requesting this since the default has
+                # changed
+                msg = _(
+                    "The --detailed option has been deprecated. " "Unset it."
+                )
+                self.log.warning(msg)
 
         columns = [
             'reference',
@@ -283,7 +344,7 @@ class BlockStorageManageSnapshots(command.Lister):
             limit=parsed_args.limit,
             offset=parsed_args.offset,
             sort=parsed_args.sort,
-            cluster=cluster,
+            cluster=parsed_args.cluster,
         )
 
         return (

openstackclient/volume/v3/block_storage_resource_filter.py

@@ -12,7 +12,8 @@
 
 """Volume V3 Resource Filters implementations"""
 
-from cinderclient import api_versions
+from openstack import utils as sdk_utils
+from osc_lib.cli import format_columns
 from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
@@ -24,9 +25,9 @@ class ListBlockStorageResourceFilter(command.Lister):
     _description = _('List block storage resource filters')
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
-        if volume_client.api_version < api_versions.APIVersion('3.33'):
+        if not sdk_utils.supports_microversion(volume_client, '3.33'):
             msg = _(
                 "--os-volume-api-version 3.33 or greater is required to "
                 "support the 'block storage resource filter list' command"
@@ -37,12 +38,20 @@ class ListBlockStorageResourceFilter(command.Lister):
             'Resource',
             'Filters',
         )
+        columns = (
+            'resource',
+            'filters',
+        )
 
-        data = volume_client.resource_filters.list()
+        data = volume_client.resource_filters()
+        formatters = {'filters': format_columns.ListColumn}
 
         return (
             column_headers,
-            (utils.get_item_properties(s, column_headers) for s in data),
+            (
+                utils.get_item_properties(s, columns, formatters=formatters)
+                for s in data
+            ),
         )
 
 
@@ -60,18 +69,16 @@ class ShowBlockStorageResourceFilter(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        volume_client = self.app.client_manager.volume
+        volume_client = self.app.client_manager.sdk_connection.volume
 
-        if volume_client.api_version < api_versions.APIVersion('3.33'):
+        if not sdk_utils.supports_microversion(volume_client, '3.33'):
             msg = _(
                 "--os-volume-api-version 3.33 or greater is required to "
                 "support the 'block storage resource filter show' command"
             )
             raise exceptions.CommandError(msg)
 
-        data = volume_client.resource_filters.list(
-            resource=parsed_args.resource
-        )
+        data = volume_client.resource_filters(resource=parsed_args.resource)
         if not data:
             msg = _(
                 "No resource filter with a name of {parsed_args.resource}' "
@@ -80,4 +87,19 @@ class ShowBlockStorageResourceFilter(command.ShowOne):
             raise exceptions.CommandError(msg)
         resource_filter = next(data)
 
-        return zip(*sorted(resource_filter._info.items()))
+        column_headers = (
+            'Resource',
+            'Filters',
+        )
+        columns = (
+            'resource',
+            'filters',
+        )
+        formatters = {'filters': format_columns.ListColumn}
+
+        return (
+            column_headers,
+            utils.get_dict_properties(
+                resource_filter, columns, formatters=formatters
+            ),
+        )

openstackclient/volume/v3/volume_attachment.py

@@ -18,6 +18,7 @@ from osc_lib.command import command
 from osc_lib import exceptions
 from osc_lib import utils
 
+from openstackclient.common import pagination
 from openstackclient.i18n import _
 from openstackclient.identity import common as identity_common
 
@@ -410,20 +411,7 @@ class ListVolumeAttachment(command.Lister):
             metavar='<status>',
             help=_('Filters results by a status. ') + _FILTER_DEPRECATED,
         )
-        parser.add_argument(
-            '--marker',
-            metavar='<marker>',
-            help=_(
-                'Begin returning volume attachments that appear later in '
-                'volume attachment list than that represented by this ID.'
-            ),
-        )
-        parser.add_argument(
-            '--limit',
-            type=int,
-            metavar='<limit>',
-            help=_('Maximum number of volume attachments to return.'),
-        )
+        pagination.add_marker_pagination_option_to_parser(parser)
         # TODO(stephenfin): Add once we have an equivalent command for
         # 'cinder list-filters'
         # parser.add_argument(