python-openstackclient 6.6.1__py3-none-any.whl → 7.0.0__py3-none-any.whl

openstackclient/volume/v3/volume_snapshot.py

@@ -0,0 +1,97 @@
+#
+#   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 v3 snapshot action implementations"""
+
+import logging
+
+from osc_lib.command import command
+from osc_lib import exceptions
+from osc_lib import utils
+
+from openstackclient.i18n import _
+
+LOG = logging.getLogger(__name__)
+
+
+class DeleteVolumeSnapshot(command.Command):
+    _description = _("Delete volume snapshot(s)")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "snapshots",
+            metavar="<snapshot>",
+            nargs="+",
+            help=_("Snapshot(s) to delete (name or ID)"),
+        )
+        parser.add_argument(
+            '--force',
+            action='store_true',
+            help=_(
+                "Attempt forced removal of snapshot(s), "
+                "regardless of state (defaults to False)"
+            ),
+        )
+        parser.add_argument(
+            '--remote',
+            action='store_true',
+            help=_(
+                'Unmanage the snapshot, removing it from the Block Storage '
+                'service management but not from the backend.'
+            ),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+        volume_client_sdk = self.app.client_manager.sdk_connection.volume
+
+        result = 0
+
+        if parsed_args.remote:
+            if parsed_args.force:
+                msg = _(
+                    "The --force option is not supported with the "
+                    "--remote parameter."
+                )
+                raise exceptions.CommandError(msg)
+
+        for i in parsed_args.snapshots:
+            try:
+                snapshot_id = utils.find_resource(
+                    volume_client.volume_snapshots, i
+                ).id
+                if parsed_args.remote:
+                    volume_client_sdk.unmanage_snapshot(snapshot_id)
+                else:
+                    volume_client.volume_snapshots.delete(
+                        snapshot_id, parsed_args.force
+                    )
+            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)

openstackclient/volume/v3/volume_transfer_request.py

@@ -0,0 +1,233 @@
+#
+#   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 v3 transfer action implementations"""
+
+import logging
+
+from cinderclient import api_versions
+from osc_lib.command import command
+from osc_lib import exceptions
+from osc_lib import utils
+
+from openstackclient.i18n import _
+
+
+LOG = logging.getLogger(__name__)
+
+
+class AcceptTransferRequest(command.ShowOne):
+    _description = _("Accept volume transfer request.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'transfer_request',
+            metavar="<transfer-request-id>",
+            help=_('Volume transfer request to accept (ID only)'),
+        )
+        parser.add_argument(
+            '--auth-key',
+            metavar="<key>",
+            required=True,
+            help=_('Volume transfer request authentication key'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+
+        try:
+            transfer_request_id = utils.find_resource(
+                volume_client.transfers, parsed_args.transfer_request
+            ).id
+        except exceptions.CommandError:
+            # Non-admin users will fail to lookup name -> ID so we just
+            # move on and attempt with the user-supplied information
+            transfer_request_id = parsed_args.transfer_request
+
+        transfer_accept = volume_client.transfers.accept(
+            transfer_request_id,
+            parsed_args.auth_key,
+        )
+        transfer_accept._info.pop("links", None)
+
+        return zip(*sorted(transfer_accept._info.items()))
+
+
+class CreateTransferRequest(command.ShowOne):
+    _description = _("Create volume transfer request.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            '--name',
+            metavar="<name>",
+            help=_('New transfer request name (default to None)'),
+        )
+        parser.add_argument(
+            '--snapshots',
+            action='store_true',
+            dest='snapshots',
+            help=_(
+                'Allow transfer volumes without snapshots (default) '
+                '(supported by --os-volume-api-version 3.55 or later)'
+            ),
+            default=None,
+        )
+        parser.add_argument(
+            '--no-snapshots',
+            action='store_false',
+            dest='snapshots',
+            help=_(
+                'Disallow transfer volumes without snapshots '
+                '(supported by --os-volume-api-version 3.55 or later)'
+            ),
+        )
+        parser.add_argument(
+            'volume',
+            metavar="<volume>",
+            help=_('Volume to transfer (name or ID)'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+
+        kwargs = {}
+
+        if parsed_args.snapshots is not None:
+            if volume_client.api_version < api_versions.APIVersion('3.55'):
+                msg = _(
+                    "--os-volume-api-version 3.55 or greater is required to "
+                    "support the '--(no-)snapshots' option"
+                )
+                raise exceptions.CommandError(msg)
+
+            # unfortunately this option is negative so we have to reverse
+            # things
+            kwargs['no_snapshots'] = not parsed_args.snapshots
+
+        volume_id = utils.find_resource(
+            volume_client.volumes,
+            parsed_args.volume,
+        ).id
+        volume_transfer_request = volume_client.transfers.create(
+            volume_id,
+            parsed_args.name,
+            **kwargs,
+        )
+        volume_transfer_request._info.pop("links", None)
+
+        return zip(*sorted(volume_transfer_request._info.items()))
+
+
+class DeleteTransferRequest(command.Command):
+    _description = _("Delete volume transfer request(s).")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'transfer_request',
+            metavar="<transfer-request>",
+            nargs="+",
+            help=_('Volume transfer request(s) to delete (name or ID)'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+        result = 0
+
+        for t in parsed_args.transfer_request:
+            try:
+                transfer_request_id = utils.find_resource(
+                    volume_client.transfers,
+                    t,
+                ).id
+                volume_client.transfers.delete(transfer_request_id)
+            except Exception as e:
+                result += 1
+                LOG.error(
+                    _(
+                        "Failed to delete volume transfer request "
+                        "with name or ID '%(transfer)s': %(e)s"
+                    )
+                    % {'transfer': t, 'e': e}
+                )
+
+        if result > 0:
+            total = len(parsed_args.transfer_request)
+            msg = _(
+                "%(result)s of %(total)s volume transfer requests failed"
+                " to delete"
+            ) % {'result': result, 'total': total}
+            raise exceptions.CommandError(msg)
+
+
+class ListTransferRequest(command.Lister):
+    _description = _("Lists all volume transfer requests.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            '--all-projects',
+            dest='all_projects',
+            action="store_true",
+            default=False,
+            help=_('Include all projects (admin only)'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        columns = ['ID', 'Name', 'Volume ID']
+        column_headers = ['ID', 'Name', 'Volume']
+
+        volume_client = self.app.client_manager.volume
+
+        volume_transfer_result = volume_client.transfers.list(
+            detailed=True,
+            search_opts={'all_tenants': parsed_args.all_projects},
+        )
+
+        return (
+            column_headers,
+            (
+                utils.get_item_properties(s, columns)
+                for s in volume_transfer_result
+            ),
+        )
+
+
+class ShowTransferRequest(command.ShowOne):
+    _description = _("Show volume transfer request details.")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'transfer_request',
+            metavar="<transfer-request>",
+            help=_('Volume transfer request to display (name or ID)'),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        volume_client = self.app.client_manager.volume
+        volume_transfer_request = utils.find_resource(
+            volume_client.transfers,
+            parsed_args.transfer_request,
+        )
+        volume_transfer_request._info.pop("links", None)
+
+        return zip(*sorted(volume_transfer_request._info.items()))