Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.
Bug 1142345 - Command Line Shell Guide Table 4.2 refers to unknown Appendix E.1
Command Line Shell Guide Table 4.2 refers to unknown Appendix E.1
Status: CLOSED CURRENTRELEASE
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation (Show other bugs)
3.3.0
Unspecified Unspecified
unspecified Severity unspecified
: ---
: ---
Assigned To: Andrew Burden
Tahlia Richardson
:
Depends On:
Blocks:
  Show dependency treegraph
 
Reported: 2014-09-16 11:31 EDT by Aram Agajanian
Modified: 2015-02-15 23:47 EST (History)
6 users (show)

See Also:
Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of:
Environment:
Build Name: 22457, Command Line Shell Guide-3.3-1 Build Date: 29-04-2014 13:25:07 Topic ID: 10179-591914 [Specified]
Last Closed: 2015-02-15 23:47:01 EST
Type: Bug
Regression: ---
Mount Type: ---
Documentation: ---
CRM:
Verified Versions:
Category: ---
oVirt Team: ---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: ---


Attachments (Terms of Use)

  None (edit)
Description Aram Agajanian 2014-09-16 11:31:07 EDT
Title: List Resources in a Collection (list)

Describe the issue:
The row in Table 4.2 for the option "--query [QUERY]" includes the following text:

For more information about search query language, refer to Appendix E.1. Search of the . 

Suggestions for improvement:
Include Appendix E.1 in the document and direct the reader to it.

Additional notes:
I am working on adding permissions to a Pool.  At this point, I only am able to list users by --name, which is first name.  The additional filtering with a  server-side query could be helpful.
Comment 1 Aram Agajanian 2014-09-16 12:18:09 EDT
The following command seems to be working

list users --query "usrname=name@domain" 

However, the domain portion is problematic because our users seem to have different string values in that field.  It probably has to due with changes over time in the way data is populated in AD.

I see that the following command works better

list users --query "usrname=name@%"  --case_sensitive false
Comment 2 Andrew Burden 2014-09-17 09:47:45 EDT
Thanks again for the wonderful feedback, Aram.
These changes will make it into the next cycle.

Cheers,
Andrew
Comment 3 Andrew Burden 2014-10-11 02:32:44 EDT
Hey Aram,

I've removed the reference to the search syntax in the Administration Guide as I don't believe it's entirely relevant after all. Instead, I've included the command 
# list --help 
in an example to provide rhevm-shell-specific list syntax.
I also used your list command provided in c#1 as the basis for another example.

I'll post links to these changes when the books are built.
Thanks again,
Andrew


Internal:
ID 10179
Comment 4 Andrew Burden 2014-10-16 02:27:20 EDT
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/sect-Resources1.html#Show_Resources_in_a_Collection_list


What Changed 
------------------------------
Removed reference to Admin Guide search syntax; replaced with example showing more relevant syntax.
Included a good example based on that supplied by the bug reporter.

List Resources in a Collection (list) [10179-716031]
Updated revision history: [34616-716400]


Versions Applicable: 3.5 (Still to be backported to 3.3, 3.4)


NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Technical_Guide-3.5-web-en-US-3.5-19.el6eng
Comment 5 Tahlia Richardson 2014-10-21 02:49:30 EDT
Checked in Red_Hat_Enterprise_Virtualization-Technical_Guide-3.5-web-en-US-3.5-20.el6eng

VERIFIED

Note You need to log in before you can comment on or make changes to this bug.