Bug 1142384 - Command Line Shell Guide Example 5.27 incorrectly uses names instead of ids
Summary: Command Line Shell Guide Example 5.27 incorrectly uses names instead of ids
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.3.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Andrew Burden
QA Contact: Tahlia Richardson
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-09-16 16:47 UTC by Aram Agajanian
Modified: 2015-02-16 04:47 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Build Name: 22457, Command Line Shell Guide-3.3-1 Build Date: 29-04-2014 13:25:07 Topic ID: 10184-591914 [Specified]
Last Closed: 2015-02-16 04:47:04 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Aram Agajanian 2014-09-16 16:47:26 UTC
Title: Section 5.11 permission

Describe the issue:
When adding a permission, there are parameters "--user-id" and "--role-id".  These have to be passed UUIDs as arguments.

The example shows arguments to the add permission command of a user name and a role name.  Instead, it should show user id and role id.

Suggestions for improvement:

Correct the text to clearly indicate that a UUID must be used for these parameters.

Additional information:

When I tried to add a permission with something other than a UUID, there was an error message like the following.

[RHEVM shell (connected)]# add permission --vmpool-identifier Cdn --role-id UserRole --user-id username

error: 
status: 400
reason: Bad Request
detail: 
Invalid UUID string: balasunr1

Comment 1 Andrew Burden 2014-09-17 13:45:45 UTC
Thank you, Aram, for your clear and helpful feedback. It is always appreciated.

I will update the documentation as per your suggestion. The changes won't make it into 3.5-Beta, which goes out tomorrow, but it will be picked up in the next cycle. 

Thanks again,
Andrew

Comment 2 Andrew Burden 2014-10-07 05:15:10 UTC
Hey Aram,

I've updated the example as per your feedback. Now:
"
# add permission --role-id 00000000-0000-0000-0000-000000000001 --user-id 8b9456ae-e2c8-426e-922d-b01bb8a805fb
"

I also updated the tables to match the relevant versions.

I'll post the links when the books are re-built.
Thanks again for the feedback,
Andrew


Internal:
3.3 ID [10184-715338]
3.4 ID [10184-715347]
3.5 ID [10184-715354]

Comment 3 Andrew Burden 2014-10-17 07:56:02 UTC
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.4/html/Technical_Guide/permission.html


What Changed 
------------------------------
Fixed example so that it correctly uses UUIDs instead of names. Made contents of tables match reality
permissions [10184-715354]

Updated revision history: [34616-716400]

Versions Applicable: 3.5, 3.4, 3.3


NVR
------------------------------
Red_Hat_Enterprise_Virtualization-Technical_Guide-3.5-web-en-US-3.5-19.el6eng

Comment 4 Tahlia Richardson 2014-10-22 02:06:46 UTC
Checked in Red_Hat_Enterprise_Virtualization-Technical_Guide-3.4-web-en-US-3.4-20.el6eng
and 
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.