python-openstackclient 8.0.0__py3-none-any.whl → 8.2.0__py3-none-any.whl

openstackclient/api/compute_v2.py

@@ -64,7 +64,7 @@ def list_security_groups(compute_client, all_projects=None):
 
 
 def find_security_group(compute_client, name_or_id):
-    """Find the name for a given security group name or ID
+    """Find the security group for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-security-group-details
 
@@ -240,7 +240,7 @@ def list_networks(compute_client):
 
 
 def find_network(compute_client, name_or_id):
-    """Find the ID for a given network name or ID
+    """Find the network for a given name or ID
 
     https://docs.openstack.org/api-ref/compute/#show-network-details
 

openstackclient/api/volume_v2.py

@@ -0,0 +1,60 @@
+#   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 API Library
+
+A collection of wrappers for deprecated Block Storage v2 APIs that are not
+intentionally supported by SDK.
+"""
+
+import http
+
+from openstack import exceptions as sdk_exceptions
+from osc_lib import exceptions
+
+
+# consistency groups
+
+
+def find_consistency_group(compute_client, name_or_id):
+    """Find the consistency group for a given name or ID
+
+    https://docs.openstack.org/api-ref/block-storage/v3/#show-a-consistency-group-s-details
+
+    :param volume_client: A volume client
+    :param name_or_id: The name or ID of the consistency group to look up
+    :returns: A consistency group object
+    :raises exception.NotFound: If a matching consistency group could not be
+        found or more than one match was found
+    """
+    response = compute_client.get(f'/consistencygroups/{name_or_id}')
+    if response.status_code != http.HTTPStatus.NOT_FOUND:
+        # there might be other, non-404 errors
+        sdk_exceptions.raise_from_response(response)
+        return response.json()['consistencygroup']
+
+    response = compute_client.get('/consistencygroups')
+    sdk_exceptions.raise_from_response(response)
+    found = None
+    consistency_groups = response.json()['consistencygroups']
+    for consistency_group in consistency_groups:
+        if consistency_group['name'] == name_or_id:
+            if found:
+                raise exceptions.NotFound(
+                    f'multiple matches found for {name_or_id}'
+                )
+            found = consistency_group
+
+    if not found:
+        raise exceptions.NotFound(f'{name_or_id} not found')
+
+    return found

openstackclient/api/volume_v3.py

@@ -0,0 +1,60 @@
+#   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 API Library
+
+A collection of wrappers for deprecated Block Storage v3 APIs that are not
+intentionally supported by SDK.
+"""
+
+import http
+
+from openstack import exceptions as sdk_exceptions
+from osc_lib import exceptions
+
+
+# consistency groups
+
+
+def find_consistency_group(compute_client, name_or_id):
+    """Find the consistency group for a given name or ID
+
+    https://docs.openstack.org/api-ref/block-storage/v3/#show-a-consistency-group-s-details
+
+    :param volume_client: A volume client
+    :param name_or_id: The name or ID of the consistency group to look up
+    :returns: A consistency group object
+    :raises exception.NotFound: If a matching consistency group could not be
+        found or more than one match was found
+    """
+    response = compute_client.get(f'/consistencygroups/{name_or_id}')
+    if response.status_code != http.HTTPStatus.NOT_FOUND:
+        # there might be other, non-404 errors
+        sdk_exceptions.raise_from_response(response)
+        return response.json()['consistencygroup']
+
+    response = compute_client.get('/consistencygroups')
+    sdk_exceptions.raise_from_response(response)
+    found = None
+    consistency_groups = response.json()['consistencygroups']
+    for consistency_group in consistency_groups:
+        if consistency_group['name'] == name_or_id:
+            if found:
+                raise exceptions.NotFound(
+                    f'multiple matches found for {name_or_id}'
+                )
+            found = consistency_group
+
+    if not found:
+        raise exceptions.NotFound(f'{name_or_id} not found')
+
+    return found

openstackclient/compute/client.py

@@ -46,3 +46,8 @@ def build_option_parser(parser):
         % DEFAULT_API_VERSION,
     )
     return parser
+
+
+def check_api_version(check_version):
+    # SDK supports auto-negotiation for us: always return True
+    return True

openstackclient/compute/v2/console.py

@@ -106,6 +106,13 @@ class ShowConsoleURL(command.ShowOne):
             const='spice-html5',
             help=_("Show SPICE console URL"),
         )
+        type_group.add_argument(
+            '--spice-direct',
+            dest='url_type',
+            action='store_const',
+            const='spice-direct',
+            help=_("Show SPICE direct protocol native console URL"),
+        )
         type_group.add_argument(
             '--rdp',
             dest='url_type',

openstackclient/compute/v2/console_connection.py

@@ -0,0 +1,48 @@
+#   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.
+#
+
+"""Compute v2 Console auth token implementations."""
+
+from osc_lib.command import command
+from osc_lib import utils
+
+from openstackclient.i18n import _
+
+
+def _get_console_connection_columns(item):
+    column_map: dict[str, str] = {}
+    hidden_columns = ['id', 'location', 'name']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns
+    )
+
+
+class ShowConsoleConnectionInformation(command.ShowOne):
+    _description = _("Show server's remote console connection information")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'token',
+            metavar='<token>',
+            help=_("Nova console token to lookup"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        compute_client = self.app.client_manager.compute
+        data = compute_client.validate_console_auth_token(parsed_args.token)
+        display_columns, columns = _get_console_connection_columns(data)
+        data = utils.get_dict_properties(data, columns)
+
+        return (display_columns, data)

openstackclient/compute/v2/flavor.py

@@ -156,12 +156,25 @@ class CreateFlavor(command.ShowOne):
             msg = _("--project is only allowed with --private")
             raise exceptions.CommandError(msg)
 
+        flavor_id = parsed_args.id
+        if parsed_args.id == 'auto':
+            # novaclient aliased 'auto' to mean "generate a UUID for me": we
+            # do the same to avoid breaking existing users
+            flavor_id = None
+
+            msg = _(
+                "Passing '--id auto' is deprecated. Nova will automatically "
+                "assign a UUID-like ID if no ID is provided. Omit the '--id' "
+                "parameter instead."
+            )
+            self.log.warning(msg)
+
         args = {
             'name': parsed_args.name,
             'ram': parsed_args.ram,
             'vcpus': parsed_args.vcpus,
             'disk': parsed_args.disk,
-            'id': parsed_args.id,
+            'id': flavor_id,
             'ephemeral': parsed_args.ephemeral,
             'swap': parsed_args.swap,
             'rxtx_factor': parsed_args.rxtx_factor,

openstackclient/compute/v2/keypair.py

@@ -300,6 +300,7 @@ class ListKeypair(command.Lister):
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.compute
         identity_client = self.app.client_manager.identity
+        identity_sdk_client = self.app.client_manager.sdk_connection.identity
 
         kwargs = {}
 
@@ -345,11 +346,17 @@ class ListKeypair(command.Lister):
                 parsed_args.project,
                 parsed_args.project_domain,
             ).id
-            users = identity_client.users.list(tenant_id=project)
+            assignments = identity_sdk_client.role_assignments(
+                scope_project_id=project
+            )
+            user_ids = set()
+            for assignment in assignments:
+                if assignment.user:
+                    user_ids.add(assignment.user['id'])
 
             data = []
-            for user in users:
-                kwargs['user_id'] = user.id
+            for user_id in user_ids:
+                kwargs['user_id'] = user_id
                 data.extend(compute_client.keypairs(**kwargs))
         elif parsed_args.user:
             if not sdk_utils.supports_microversion(compute_client, '2.10'):

openstackclient/compute/v2/server.py

@@ -21,7 +21,6 @@ import getpass
 import json
 import logging
 import os
-import typing as ty
 
 from cliff import columns as cliff_columns
 import iso8601
@@ -185,6 +184,7 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
         'user_data': 'OS-EXT-SRV-ATTR:user_data',
         'vm_state': 'OS-EXT-STS:vm_state',
         'pinned_availability_zone': 'pinned_availability_zone',
+        'scheduler_hints': 'scheduler_hints',
     }
     # Some columns returned by openstacksdk should not be shown because they're
     # either irrelevant or duplicates
@@ -205,7 +205,6 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
         'min_count',
         'networks',
         'personality',
-        'scheduler_hints',
         # aliases
         'volumes',
         # unnecessary
@@ -236,6 +235,11 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
 
     info = data
 
+    # NOTE(dviroel): microversion 2.100 is now retrieving scheduler_hints
+    #  content from request_spec on detailed responses
+    if not sdk_utils.supports_microversion(compute_client, '2.100'):
+        info.pop('scheduler_hints', None)
+
     # Convert the image blob to a name
     image_info = info.get('image', {})
     if image_info and any(image_info.values()):
@@ -322,6 +326,11 @@ def _prep_server_detail(compute_client, image_client, server, *, refresh=True):
             info['OS-EXT-STS:power_state']
         )
 
+    if 'scheduler_hints' in info:
+        info['scheduler_hints'] = format_columns.DictListColumn(
+            info.pop('scheduler_hints', {}),
+        )
+
     return info
 
 
@@ -1864,7 +1873,7 @@ class CreateServer(command.ShowOne):
 
         # Default to empty list if nothing was specified and let nova
         # decide the default behavior.
-        networks: ty.Union[str, list[dict[str, str]], None] = []
+        networks: str | list[dict[str, str]] | None = []
 
         if 'auto' in parsed_args.nics or 'none' in parsed_args.nics:
             if len(parsed_args.nics) > 1:
@@ -1938,9 +1947,9 @@ class CreateServer(command.ShowOne):
                     network['port'] = nic['port-id']
 
                 if nic['v4-fixed-ip']:
-                    network['fixed'] = nic['v4-fixed-ip']
+                    network['fixed_ip'] = nic['v4-fixed-ip']
                 elif nic['v6-fixed-ip']:
-                    network['fixed'] = nic['v6-fixed-ip']
+                    network['fixed_ip'] = nic['v6-fixed-ip']
 
                 if nic.get('tag'):  # tags are optional
                     network['tag'] = nic['tag']
@@ -2120,13 +2129,11 @@ class CreateServer(command.ShowOne):
                     f.close()
 
         if parsed_args.wait:
-            if utils.wait_for_status(
+            if not utils.wait_for_status(
                 compute_client.get_server,
                 server.id,
                 callback=_show_progress,
             ):
-                self.app.stdout.write('\n')
-            else:
                 msg = _('Error creating server: %s') % parsed_args.server_name
                 raise exceptions.CommandError(msg)
 
@@ -2834,14 +2841,20 @@ class ListServer(command.Lister):
                 'pinned_availability_zone',
                 'hypervisor_hostname',
                 'metadata',
+                'scheduler_hints',
             )
             column_headers += (
                 'Availability Zone',
                 'Pinned Availability Zone',
                 'Host',
                 'Properties',
+                'Scheduler Hints',
             )
 
+        if parsed_args.all_projects:
+            columns += ('project_id',)
+            column_headers += ('Project ID',)
+
         # support for additional columns
         if parsed_args.columns:
             for c in parsed_args.columns:
@@ -2884,6 +2897,12 @@ class ListServer(command.Lister):
                 if c in ('Properties', "properties"):
                     columns += ('Metadata',)
                     column_headers += ('Properties',)
+                if c in (
+                    'scheduler_hints',
+                    "Scheduler Hints",
+                ):
+                    columns += ('scheduler_hints',)
+                    column_headers += ('Scheduler Hints',)
 
             # remove duplicates
             column_headers = tuple(dict.fromkeys(column_headers))
@@ -2986,7 +3005,7 @@ class ListServer(command.Lister):
                 # infrastructure failure situations.
                 # For those servers with partial constructs we just skip the
                 # processing of the image and flavor information.
-                if not hasattr(s, 'image') or not hasattr(s, 'flavor'):
+                if getattr(s, 'status') == 'UNKNOWN':
                     continue
 
             if 'id' in s.image and s.image.id is not None:
@@ -3050,6 +3069,7 @@ class ListServer(command.Lister):
                         'metadata': format_columns.DictColumn,
                         'security_groups_name': format_columns.ListColumn,
                         'hypervisor_hostname': HostColumn,
+                        'scheduler_hints': format_columns.DictListColumn,
                     },
                 )
                 for s in data
@@ -3860,9 +3880,15 @@ host."""
         compute_client.evacuate_server(server, **kwargs)
 
         if parsed_args.wait:
+            orig_status = server.status
+            success = ['ACTIVE']
+            if orig_status == 'SHUTOFF':
+                success.append('SHUTOFF')
+
             if utils.wait_for_status(
                 compute_client.get_server,
                 server.id,
+                success_status=success,
                 callback=_show_progress,
             ):
                 self.app.stdout.write(_('Complete\n'))
@@ -4462,15 +4488,27 @@ class SetServer(command.Command):
                 '(repeat option to set multiple properties)'
             ),
         )
+        parser.add_argument(
+            '--auto-approve',
+            action='store_true',
+            help=_(
+                "Allow server state override without asking for confirmation"
+            ),
+        )
         parser.add_argument(
             '--state',
             metavar='<state>',
             choices=['active', 'error'],
             help=_(
-                'New server state '
-                '**WARNING** This can result in instances that are no longer '
-                'usable and should be used with caution '
-                '(admin only)'
+                'New server state.'
+                '**WARNING** Resetting the state is intended to work around '
+                'servers stuck in an intermediate state, such as deleting. '
+                'If the server is in an error state then this is almost '
+                'never the correct command to run and you should prefer hard '
+                'reboot where possible. In particular, if the server is in '
+                'an error state due to a move operation, setting the state '
+                'can result in instances that are no longer usable. Proceed '
+                'with caution. (admin only)'
             ),
         )
         parser.add_argument(
@@ -4505,6 +4543,20 @@ class SetServer(command.Command):
         )
         return parser
 
+    @staticmethod
+    def ask_user_yesno(msg):
+        """Ask user Y/N question
+
+        :param str msg: question text
+        :return bool: User choice
+        """
+        while True:
+            answer = getpass.getpass('{} [{}]: '.format(msg, 'y/n'))
+            if answer in ('y', 'Y', 'yes'):
+                return True
+            elif answer in ('n', 'N', 'no'):
+                return False
+
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
@@ -4555,6 +4607,17 @@ class SetServer(command.Command):
             )
 
         if parsed_args.state:
+            if not parsed_args.auto_approve:
+                if not self.ask_user_yesno(
+                    _(
+                        "Resetting the server state can make it much harder "
+                        "to recover a server from an error state. If the "
+                        "server is in error status due to a failed move "
+                        "operation then this is likely not the correct "
+                        "approach to fix the problem. Do you wish to continue?"
+                    )
+                ):
+                    return
             compute_client.reset_server_state(server, state=parsed_args.state)
 
         if parsed_args.root_password:

openstackclient/compute/v2/server_event.py

@@ -82,7 +82,7 @@ class ServerActionEventColumn(columns.FormattableColumn):
 
 
 def _get_server_event_columns(item, client):
-    hidden_columns = ['name', 'server_id', 'links', 'location']
+    hidden_columns = ['name', 'server_id', 'links', 'location', 'finish_time']
 
     if not sdk_utils.supports_microversion(client, '2.58'):
         # updated_at was introduced in 2.58

openstackclient/identity/common.py

@@ -189,6 +189,16 @@ def find_domain(identity_client, name_or_id):
     )
 
 
+def find_domain_id_sdk(
+    identity_client, name_or_id, *, validate_actor_existence=True
+):
+    return _find_sdk_id(
+        identity_client.find_domain,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+    )
+
+
 def find_group(identity_client, name_or_id, domain_name_or_id=None):
     if domain_name_or_id is None:
         return _find_identity_resource(
@@ -204,6 +214,33 @@ def find_group(identity_client, name_or_id, domain_name_or_id=None):
     )
 
 
+def find_group_id_sdk(
+    identity_client,
+    name_or_id,
+    domain_name_or_id=None,
+    *,
+    validate_actor_existence=True,
+):
+    if domain_name_or_id is None:
+        return _find_sdk_id(
+            identity_client.find_group,
+            name_or_id=name_or_id,
+            validate_actor_existence=validate_actor_existence,
+        )
+
+    domain_id = find_domain_id_sdk(
+        identity_client,
+        name_or_id=domain_name_or_id,
+        validate_actor_existence=validate_actor_existence,
+    )
+    return _find_sdk_id(
+        identity_client.find_group,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+        domain_id=domain_id,
+    )
+
+
 def find_project(identity_client, name_or_id, domain_name_or_id=None):
     if domain_name_or_id is None:
         return _find_identity_resource(
@@ -229,6 +266,32 @@ def find_user(identity_client, name_or_id, domain_name_or_id=None):
     )
 
 
+def find_user_id_sdk(
+    identity_client,
+    name_or_id,
+    domain_name_or_id=None,
+    *,
+    validate_actor_existence=True,
+):
+    if domain_name_or_id is None:
+        return _find_sdk_id(
+            identity_client.find_user,
+            name_or_id=name_or_id,
+            validate_actor_existence=validate_actor_existence,
+        )
+    domain_id = find_domain_id_sdk(
+        identity_client,
+        name_or_id=domain_name_or_id,
+        validate_actor_existence=validate_actor_existence,
+    )
+    return _find_sdk_id(
+        identity_client.find_user,
+        name_or_id=name_or_id,
+        validate_actor_existence=validate_actor_existence,
+        domain_id=domain_id,
+    )
+
+
 def _find_identity_resource(
     identity_client_manager, name_or_id, resource_type, **kwargs
 ):
@@ -269,13 +332,20 @@ def _find_identity_resource(
     return resource_type(None, {'id': name_or_id, 'name': name_or_id})
 
 
-def get_immutable_options(parsed_args):
-    options = {}
-    if parsed_args.immutable:
-        options['immutable'] = True
-    if parsed_args.no_immutable:
-        options['immutable'] = False
-    return options
+def _find_sdk_id(
+    find_command, name_or_id, *, validate_actor_existence=True, **kwargs
+):
+    try:
+        resource = find_command(
+            name_or_id=name_or_id, ignore_missing=False, **kwargs
+        )
+    except sdk_exceptions.ForbiddenException:
+        return name_or_id
+    except sdk_exceptions.ResourceNotFound as exc:
+        if not validate_actor_existence:
+            return name_or_id
+        raise exceptions.CommandError from exc
+    return resource.id
 
 
 def add_user_domain_option_to_parser(parser):
@@ -340,17 +410,21 @@ def add_inherited_option_to_parser(parser):
 
 
 def add_resource_option_to_parser(parser):
-    enable_group = parser.add_mutually_exclusive_group()
-    enable_group.add_argument(
+    immutable_group = parser.add_mutually_exclusive_group()
+    immutable_group.add_argument(
         '--immutable',
         action='store_true',
+        dest='immutable',
+        default=None,
         help=_(
             'Make resource immutable. An immutable project may not '
             'be deleted or modified except to remove the immutable flag'
         ),
     )
-    enable_group.add_argument(
+    immutable_group.add_argument(
         '--no-immutable',
-        action='store_true',
+        action='store_false',
+        dest='immutable',
+        default=None,
         help=_('Make resource mutable (default)'),
     )