python-openstackclient 7.2.0__py3-none-any.whl → 7.3.0__py3-none-any.whl

openstackclient/common/clientmanager.py

@@ -129,10 +129,15 @@ class ClientManager(clientmanager.ClientManager):
     # TODO(stephenfin): Drop volume_client argument in OSC 8.0 or later.
     def is_volume_endpoint_enabled(self, volume_client=None):
         """Check if volume endpoint is enabled"""
+        # We check against the service type and all aliases defined by the
+        # Service Types Authority
+        # https://service-types.openstack.org/service-types.json
         return (
-            self.is_service_available('volume') is not False
+            self.is_service_available('block-storage') is not False
+            or self.is_service_available('volume') is not False
             or self.is_service_available('volumev3') is not False
             or self.is_service_available('volumev2') is not False
+            or self.is_service_available('block-store') is not False
         )
 
 

openstackclient/common/limits.py

@@ -130,7 +130,7 @@ class ShowLimits(command.Lister):
         if self.app.client_manager.is_volume_endpoint_enabled():
             volume_client = self.app.client_manager.sdk_connection.volume
             volume_limits = volume_client.get_limits(
-                project_id=project_id,
+                project=project_id,
             )
 
         if parsed_args.is_absolute:

openstackclient/common/quota.py

@@ -249,9 +249,14 @@ class ListQuota(command.Lister):
         for project_id in project_ids:
             try:
                 project_data = compute_client.get_quota_set(project_id)
+            # NOTE(stephenfin): Unfortunately, Nova raises a HTTP 400 (Bad
+            # Request) if the project ID is invalid, even though the project
+            # ID is actually the resource's identifier which would normally
+            # lead us to expect a HTTP 404 (Not Found).
             except (
-                sdk_exceptions.NotFoundException,
+                sdk_exceptions.BadRequestException,
                 sdk_exceptions.ForbiddenException,
+                sdk_exceptions.NotFoundException,
             ) as exc:
                 # Project not found, move on to next one
                 LOG.warning(f"Project {project_id} not found: {exc}")
@@ -312,8 +317,8 @@ class ListQuota(command.Lister):
             try:
                 project_data = volume_client.get_quota_set(project_id)
             except (
-                sdk_exceptions.NotFoundException,
                 sdk_exceptions.ForbiddenException,
+                sdk_exceptions.NotFoundException,
             ) as exc:
                 # Project not found, move on to next one
                 LOG.warning(f"Project {project_id} not found: {exc}")

openstackclient/compute/v2/server.py

@@ -714,7 +714,8 @@ class AddServerSecurityGroup(command.Command):
         for security_group in security_groups:
             try:
                 compute_client.add_security_group_to_server(
-                    server, security_group
+                    server,
+                    {'name': security_group},
                 )
             except sdk_exceptions.HttpException as e:
                 errors += 1
@@ -1356,14 +1357,26 @@ class CreateServer(command.ShowOne):
                 'This option requires cloud support.'
             ),
         )
-        parser.add_argument(
+        secgroups = parser.add_mutually_exclusive_group()
+        secgroups.add_argument(
+            '--no-security-group',
+            dest='security_groups',
+            action='store_const',
+            const=[],
+            help=_(
+                'Do not associate a security group with ports attached to '
+                'this server. This does not affect the security groups '
+                'associated with pre-existing ports.'
+            ),
+        )
+        secgroups.add_argument(
             '--security-group',
             metavar='<security-group>',
             action='append',
-            default=[],
             dest='security_groups',
             help=_(
-                'Security group to assign to this server (name or ID) '
+                'Security group to associate with ports attached to this '
+                'server (name or ID) '
                 '(repeat option to set multiple groups)'
             ),
         )
@@ -1980,22 +1993,24 @@ class CreateServer(command.ShowOne):
             networks = 'auto'
 
         # Check security group(s) exist and convert ID to name
-        security_groups = []
-        if self.app.client_manager.is_network_endpoint_enabled():
-            network_client = self.app.client_manager.network
-            for security_group in parsed_args.security_groups:
-                sg = network_client.find_security_group(
-                    security_group, ignore_missing=False
-                )
-                # Use security group ID to avoid multiple security group have
-                # same name in neutron networking backend
-                security_groups.append({'name': sg.id})
-        else:  # nova-network
-            for security_group in parsed_args.security_groups:
-                sg = compute_v2.find_security_group(
-                    compute_client, security_group
-                )
-                security_groups.append({'name': sg['name']})
+        security_groups = None
+        if parsed_args.security_groups is not None:
+            security_groups = []
+            if self.app.client_manager.is_network_endpoint_enabled():
+                network_client = self.app.client_manager.network
+                for security_group in parsed_args.security_groups:
+                    sg = network_client.find_security_group(
+                        security_group, ignore_missing=False
+                    )
+                    # Use security group ID to avoid multiple security group
+                    # have same name in neutron networking backend
+                    security_groups.append({'name': sg.id})
+            else:  # nova-network
+                for security_group in parsed_args.security_groups:
+                    sg = compute_v2.find_security_group(
+                        compute_client, security_group
+                    )
+                    security_groups.append({'name': sg['name']})
 
         hints = {}
         for key, values in parsed_args.hints.items():
@@ -2058,7 +2073,7 @@ class CreateServer(command.ShowOne):
         if files:
             kwargs['personality'] = files
 
-        if security_groups:
+        if security_groups is not None:
             kwargs['security_groups'] = security_groups
 
         if block_device_mapping_v2:
@@ -4083,7 +4098,8 @@ class RemoveServerSecurityGroup(command.Command):
         for security_group in security_groups:
             try:
                 compute_client.remove_security_group_from_server(
-                    server, security_group
+                    server,
+                    {'name': security_group},
                 )
             except sdk_exceptions.HttpException as e:
                 errors += 1

openstackclient/compute/v2/usage.py

@@ -153,7 +153,7 @@ class ListUsage(command.Lister):
         )
 
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.utcnow()
+        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(
@@ -238,7 +238,7 @@ class ShowUsage(command.ShowOne):
         identity_client = self.app.client_manager.identity
         compute_client = self.app.client_manager.sdk_connection.compute
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.utcnow()
+        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(

openstackclient/identity/common.py

@@ -184,13 +184,6 @@ def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
         return parsed_name
 
 
-def _get_domain_id_if_requested(identity_client, domain_name_or_id):
-    if not domain_name_or_id:
-        return None
-    domain = find_domain(identity_client, domain_name_or_id)
-    return domain.id
-
-
 def find_domain(identity_client, name_or_id):
     return _find_identity_resource(
         identity_client.domains, name_or_id, domains.Domain
@@ -198,48 +191,43 @@ def find_domain(identity_client, name_or_id):
 
 
 def find_group(identity_client, name_or_id, domain_name_or_id=None):
-    domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
-    if not domain_id:
+    if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.groups, name_or_id, groups.Group
         )
-    else:
-        domain_id = find_domain(identity_client, domain_id).id
-        return _find_identity_resource(
-            identity_client.groups,
-            name_or_id,
-            groups.Group,
-            domain_id=domain_id,
-        )
+
+    domain_id = find_domain(identity_client, domain_name_or_id).id
+    return _find_identity_resource(
+        identity_client.groups,
+        name_or_id,
+        groups.Group,
+        domain_id=domain_id,
+    )
 
 
 def find_project(identity_client, name_or_id, domain_name_or_id=None):
-    domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
-    if not domain_id:
+    if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.projects, name_or_id, projects.Project
         )
-    else:
-        domain_id = find_domain(identity_client, domain_id).id
-        return _find_identity_resource(
-            identity_client.projects,
-            name_or_id,
-            projects.Project,
-            domain_id=domain_id,
-        )
+    domain_id = find_domain(identity_client, domain_name_or_id).id
+    return _find_identity_resource(
+        identity_client.projects,
+        name_or_id,
+        projects.Project,
+        domain_id=domain_id,
+    )
 
 
 def find_user(identity_client, name_or_id, domain_name_or_id=None):
-    domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
-    if not domain_id:
+    if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.users, name_or_id, users.User
         )
-    else:
-        domain_id = find_domain(identity_client, domain_id).id
-        return _find_identity_resource(
-            identity_client.users, name_or_id, users.User, domain_id=domain_id
-        )
+    domain_id = find_domain(identity_client, domain_name_or_id).id
+    return _find_identity_resource(
+        identity_client.users, name_or_id, users.User, domain_id=domain_id
+    )
 
 
 def _find_identity_resource(

openstackclient/identity/v3/credential.py

@@ -28,6 +28,23 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
+def _format_credential(credential):
+    columns = (
+        'blob',
+        'id',
+        'project_id',
+        'type',
+        'user_id',
+    )
+    return (
+        columns,
+        utils.get_item_properties(
+            credential,
+            columns,
+        ),
+    )
+
+
 class CreateCredential(command.ShowOne):
     _description = _("Create new credential")
 
@@ -60,25 +77,24 @@ class CreateCredential(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        user_id = utils.find_resource(
-            identity_client.users, parsed_args.user
+        identity_client = self.app.client_manager.sdk_connection.identity
+        user_id = identity_client.find_user(
+            parsed_args.user, ignore_missing=False
         ).id
         if parsed_args.project:
-            project = utils.find_resource(
-                identity_client.projects, parsed_args.project
+            project = identity_client.find_project(
+                parsed_args.project, ignore_missing=False
             ).id
         else:
             project = None
-        credential = identity_client.credentials.create(
+        credential = identity_client.create_credential(
             user=user_id,
             type=parsed_args.type,
             blob=parsed_args.data,
             project=project,
         )
 
-        credential._info.pop('links')
-        return zip(*sorted(credential._info.items()))
+        return _format_credential(credential)
 
 
 class DeleteCredential(command.Command):
@@ -95,11 +111,11 @@ class DeleteCredential(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
         result = 0
         for i in parsed_args.credential:
             try:
-                identity_client.credentials.delete(i)
+                identity_client.delete_credential(i)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -137,14 +153,17 @@ class ListCredential(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         kwargs = {}
         if parsed_args.user:
-            user_id = common.find_user(
-                identity_client,
-                parsed_args.user,
-                parsed_args.user_domain,
+            domain_id = None
+            if parsed_args.user_domain:
+                domain_id = identity_client.find_domain(
+                    parsed_args.user_domain, ignore_missing=False
+                )
+            user_id = identity_client.find_user(
+                parsed_args.user, domain_id=domain_id, ignore_missing=False
             ).id
             kwargs["user_id"] = user_id
 
@@ -153,7 +172,8 @@ class ListCredential(command.Lister):
 
         columns = ('ID', 'Type', 'User ID', 'Blob', 'Project ID')
         column_headers = ('ID', 'Type', 'User ID', 'Data', 'Project ID')
-        data = self.app.client_manager.identity.credentials.list(**kwargs)
+        data = identity_client.credentials(**kwargs)
+
         return (
             column_headers,
             (
@@ -206,20 +226,20 @@ class SetCredential(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        user_id = utils.find_resource(
-            identity_client.users, parsed_args.user
+        user_id = identity_client.find_user(
+            parsed_args.user, ignore_missing=False
         ).id
 
         if parsed_args.project:
-            project = utils.find_resource(
-                identity_client.projects, parsed_args.project
+            project = identity_client.find_project(
+                parsed_args.project, ignore_missing=False
             ).id
         else:
             project = None
 
-        identity_client.credentials.update(
+        identity_client.update_credential(
             parsed_args.credential,
             user=user_id,
             type=parsed_args.type,
@@ -241,10 +261,7 @@ class ShowCredential(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        credential = utils.find_resource(
-            identity_client.credentials, parsed_args.credential
-        )
+        identity_client = self.app.client_manager.sdk_connection.identity
+        credential = identity_client.get_credential(parsed_args.credential)
 
-        credential._info.pop('links')
-        return zip(*sorted(credential._info.items()))
+        return _format_credential(credential)

openstackclient/identity/v3/limit.py

@@ -90,6 +90,13 @@ class CreateLimit(command.ShowOne):
                 region = common_utils.get_resource(
                     identity_client.regions, parsed_args.region
                 )
+            else:
+                self.log.warning(
+                    _(
+                        "Passing 'None' to indicate no region is deprecated. "
+                        "Instead, don't pass --region."
+                    )
+                )
 
         limit = identity_client.limits.create(
             project,
@@ -158,6 +165,14 @@ class ListLimit(command.Lister):
                 region = common_utils.get_resource(
                     identity_client.regions, parsed_args.region
                 )
+            else:
+                self.log.warning(
+                    _(
+                        "Passing 'None' to indicate no region is deprecated. "
+                        "Instead, don't pass --region."
+                    )
+                )
+
         project = None
         if parsed_args.project:
             project = utils.find_resource(

openstackclient/identity/v3/region.py

@@ -25,6 +25,15 @@ from openstackclient.i18n import _
 LOG = logging.getLogger(__name__)
 
 
+def _format_region(region):
+    columns = ('id', 'description', 'parent_region_id')
+    column_headers = ('region', 'description', 'parent_region')
+    return (
+        column_headers,
+        utils.get_item_properties(region, columns),
+    )
+
+
 class CreateRegion(command.ShowOne):
     _description = _("Create new region")
 
@@ -50,18 +59,15 @@ class CreateRegion(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        region = identity_client.regions.create(
+        region = identity_client.create_region(
             id=parsed_args.region,
-            parent_region=parsed_args.parent_region,
+            parent_region_id=parsed_args.parent_region,
             description=parsed_args.description,
         )
 
-        region._info['region'] = region._info.pop('id')
-        region._info['parent_region'] = region._info.pop('parent_region_id')
-        region._info.pop('links', None)
-        return zip(*sorted(region._info.items()))
+        return _format_region(region)
 
 
 class DeleteRegion(command.Command):
@@ -78,11 +84,11 @@ class DeleteRegion(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
         result = 0
         for i in parsed_args.region:
             try:
-                identity_client.regions.delete(i)
+                identity_client.delete_region(i)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -115,7 +121,7 @@ class ListRegion(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         kwargs = {}
         if parsed_args.parent_region:
@@ -124,7 +130,7 @@ class ListRegion(command.Lister):
         columns_headers = ('Region', 'Parent Region', 'Description')
         columns = ('ID', 'Parent Region Id', 'Description')
 
-        data = identity_client.regions.list(**kwargs)
+        data = identity_client.regions(**kwargs)
         return (
             columns_headers,
             (
@@ -161,15 +167,15 @@ class SetRegion(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         kwargs = {}
         if parsed_args.description:
             kwargs['description'] = parsed_args.description
         if parsed_args.parent_region:
-            kwargs['parent_region'] = parsed_args.parent_region
+            kwargs['parent_region_id'] = parsed_args.parent_region
 
-        identity_client.regions.update(parsed_args.region, **kwargs)
+        identity_client.update_region(parsed_args.region, **kwargs)
 
 
 class ShowRegion(command.ShowOne):
@@ -185,13 +191,8 @@ class ShowRegion(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        region = utils.find_resource(
-            identity_client.regions, parsed_args.region
-        )
+        region = identity_client.get_region(parsed_args.region)
 
-        region._info['region'] = region._info.pop('id')
-        region._info['parent_region'] = region._info.pop('parent_region_id')
-        region._info.pop('links', None)
-        return zip(*sorted(region._info.items()))
+        return _format_region(region)

openstackclient/identity/v3/registered_limit.py

@@ -81,6 +81,13 @@ class CreateRegisteredLimit(command.ShowOne):
                 region = common_utils.get_resource(
                     identity_client.regions, parsed_args.region
                 )
+            else:
+                self.log.warning(
+                    _(
+                        "Passing 'None' to indicate no region is deprecated. "
+                        "Instead, don't pass --region."
+                    )
+                )
 
         registered_limit = identity_client.registered_limits.create(
             service,
@@ -182,6 +189,13 @@ class ListRegisteredLimit(command.Lister):
                 region = common_utils.get_resource(
                     identity_client.regions, parsed_args.region
                 )
+            else:
+                self.log.warning(
+                    _(
+                        "Passing 'None' to indicate no region is deprecated. "
+                        "Instead, don't pass --region."
+                    )
+                )
 
         registered_limits = identity_client.registered_limits.list(
             service=service,
@@ -280,6 +294,10 @@ class SetRegisteredLimit(command.ShowOne):
                 region = common_utils.get_resource(
                     identity_client.regions, parsed_args.region
                 )
+            else:
+                self.log.warning(
+                    _("Passing 'None' to indicate no region is deprecated.")
+                )
 
         registered_limit = identity_client.registered_limits.update(
             parsed_args.registered_limit_id,