openstack
/
python-openstackclient
Code Issues Proposed changes

Add filtering by project/user for 'openstack volume list' 

added project, user and domain options for filtering results,
also cleaned up the order to match the docs.

Co-Authored-By: Steve Martinelli <stevemar@ca.ibm.com>

Closed-bug: #1483976
Change-Id: I9d955094d31d4a28e215d24f7521a11c62bee8db
This commit is contained in:
kafka 2015-08-12 12:22:41 +08:00 committed by Steve Martinelli
parent b60a9492a3
commit 9f51ccdf8c
2 changed files with 58 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/command-objects/volume.rst
View File

@ -102,22 +102,40 @@ List volumes
.. code:: bash
os volume list
[--status <status>]
[--name <name>]
[--all-projects]
[--project <project> [--project-domain <project-domain>]]
[--user <user> [--user-domain <user-domain>]]
[--name <name>]
[--status <status>]
[--long]
.. option:: --status <status>
.. option:: --all-projects
Filter results by status
.. option:: --project <project>
Filter results by project (name or ID) (admin only)
.. option:: --project-domain <project-domain>
Domain the project belongs to (name or ID).
This can be used in case collisions between project names exist.
.. option:: --user <user>
Filter results by user (name or ID) (admin only)
.. option:: --user-domain <user-domain>
Domain the user belongs to (name or ID).
This can be used in case collisions between user names exist.
.. option:: --name <name>
Filter results by name
.. option:: --all-projects
.. option:: --status <status>
Include all projects (admin only)
Filter results by status
.. option:: --long

39
openstackclient/volume/v2/volume.py
View File

@ -25,6 +25,7 @@ import six
from openstackclient.common import parseractions
from openstackclient.common import utils
from openstackclient.identity import common as identity_common
class CreateVolume(show.ShowOne):
@ -206,11 +207,17 @@ class ListVolume(lister.Lister):
help='Include all projects (admin only)',
)
parser.add_argument(
'--long',
action='store_true',
default=False,
help='List additional fields in output',
'--project',
metavar='<project-id>',
help='Filter results by project (name or ID) (admin only)'
)
identity_common.add_project_domain_option_to_parser(parser)
parser.add_argument(
'--user',
metavar='<user-id>',
help='Filter results by user (name or ID) (admin only)'
)
identity_common.add_user_domain_option_to_parser(parser)
parser.add_argument(
'--name',
metavar='<name>',
@ -221,6 +228,12 @@ class ListVolume(lister.Lister):
metavar='<status>',
help='Filter results by status',
)
parser.add_argument(
'--long',
action='store_true',
default=False,
help='List additional fields in output',
)
return parser
@utils.log_method(log)
@ -228,6 +241,7 @@ class ListVolume(lister.Lister):
volume_client = self.app.client_manager.volume
compute_client = self.app.client_manager.compute
identity_client = self.app.client_manager.identity
def _format_attach(attachments):
"""Return a formatted string of a volume's attached instances
@ -282,8 +296,23 @@ class ListVolume(lister.Lister):
# Just forget it if there's any trouble
pass
project_id = None
if parsed_args.project:
project_id = identity_common.find_project(
identity_client,
parsed_args.project,
parsed_args.project_domain)
user_id = None
if parsed_args.user:
user_id = identity_common.find_project(identity_client,
parsed_args.user,
parsed_args.user_domain)
search_opts = {
'all_projects': parsed_args.all_projects,
'all_tenants': parsed_args.all_projects,
'project_id': project_id,
'user_id': user_id,
'display_name': parsed_args.name,
'status': parsed_args.status,
}