Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1142372

Summary:	Command Line Shell Guide Example 5.40 is confusing
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Aram Agajanian <agajania>
Component:	Documentation	Assignee:	Andrew Burden <aburden>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Tahlia Richardson <trichard>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	3.3.0	CC:	ecohen, gklein, juwu, rbalakri, trichard, yeylon
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
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: 10160-608733 [Specified]
Last Closed:	2015-02-16 04:47:01 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Aram Agajanian 2014-09-16 16:21:07 UTC

Title: Section 5.20 user

Describe the issue:
I want to add a new user to RHEV.  In the Command Line Shell Guide, Example 5.40 is the following command:

add user -user_name jsmith --domain-name www.example.com/accounts/groups/mygroup

I am confused by the argument to the --domain-name parameter.  I would expect a domain name to be something like "example.com".

Also, the "-user_name" parameter is incorrect.  It should be "--user_name".

Suggestions for improvement:
Explain the --domain-name parameter and correct the -user_name parameter.

Additional information:
I was able to get the add user command working by using a --domain-id parameter.  For example, the following command worked:

add user --user_name jsmith --domain-id 16137469-7765-2e6e-6577-60716c747a2e

The --domain-id argument can be found by using the "list domains" command.

Comment 1 Andrew Burden 2014-09-17 13:45:48 UTC

Thank you kindly for the clear and detailed improvement. I'll make sure these changes make it into the next cycle.

Thanks again,
Andrew

Comment 2 Andrew Burden 2014-10-07 03:54:50 UTC

Hey Aram,

I spun up 3.3 (3.3.4-0.53.el6ev) and 3.4 (3.4.2-0.2.el6ev) environments using subscription-manager and have found the --domain-name parameter to work in both environments. As a result, I have left the --domain-name in the example. 

I have updated the example (now Example 14.40 of the Technical Guide) as per your suggestions. It now reads:
"
# add user --user_name jsmith --domain-name example.com
"

Hopefully that clarifies the usage of the --domain-name parameter.
I will backport these changes to the 3.3 and 3.4 docs and provide links when these builds are complete.

Thank you again for your feedback,
Andrew

Internal:
ID 10160-715168

Comment 3 Aram Agajanian 2014-10-07 15:51:09 UTC

Hi Andrew,

I am now able to add users with the --domain-name parameter.  Thanks!

Aram

Comment 4 Andrew Burden 2014-10-16 06:32:58 UTC

You're welcome, Aram. Thanks for the feedback.

For QA:
Documentation Link
------------------------------
http://documentation-devel.engineering.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html/Technical_Guide/user.html


What Changed 
------------------------------
Corrected the 'user_name' parameter and the example usage of 'domain-name'.

user [10160-715168]
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 06:55:20 UTC

Checked in Red_Hat_Enterprise_Virtualization-Technical_Guide-3.5-web-en-US-3.5-20.el6eng

VERIFIED