Bug 633981 - for mod commands - it should be noted that --all --raw are for output format
Summary: for mod commands - it should be noted that --all --raw are for output format
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: freeIPA
Classification: Retired
Component: ipa-admintools
Version: 2.0
Hardware: All
OS: Linux
low
low
Target Milestone: ---
Assignee: Rob Crittenden
QA Contact: Chandrasekar Kannan
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2010-09-14 20:12 UTC by Jenny Severance
Modified: 2015-01-04 23:43 UTC (History)
3 users (show)

Fixed In Version: freeipa-2.0.0-1.fc15
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-03-27 07:15:04 UTC
Embargoed:


Attachments (Terms of Use)

Description Jenny Severance 2010-09-14 20:12:40 UTC
Description of problem:
For the ipa <topic>-mod commands the help should note that the --all and --raw options manipulate what is returned on completion of executing the command. 

<snip>
Purpose: Modify host.
Usage: ipa [global-options] host-mod HOSTNAME

Options:
  -h, --help           show this help message and exit
  --desc=STR           A description of this host
  --locality=STR       Host locality (e.g. "Baltimore, MD")
  --location=STR       Host location (e.g. "Lab 2")
  --platform=STR       Host hardware platform (e.g. "Lenovo T61")
  --os=STR             Host operating system and version (e.g. "Fedora 9")
  --password=STR       Password used in bulk enrollment
  --certificate=BYTES  Base-64 encoded server certificate
  --addattr=STR        Add an attribute/value pair. Format is attr=value
  --setattr=STR        Set an attribute to an name/value pair. Format is
                       attr=value
  --principalname=STR  Kerberos principal name for this host
  --all                retrieve all attributes
  --raw                print entries as stored on the server
</snip>

Based on the help it is not obvious and would help if this was noted.


Version-Release number of selected component (if applicable):


How reproducible:


Steps to Reproduce:
1.
2.
3.
  
Actual results:


Expected results:


Additional info:

Comment 1 Rob Crittenden 2010-09-18 01:47:37 UTC
https://fedorahosted.org/freeipa/ticket/244

Comment 2 Dmitri Pal 2010-12-10 22:48:56 UTC
Fixed in a874d5f8e5b432f699362730a994e838594735ec

Comment 3 Jenny Severance 2011-06-10 17:13:07 UTC
verified

# ipa help group-mod
Purpose: Modify a group.
Usage: ipa [global-options] group-mod GROUP-NAME [options]

Options:
  -h, --help     show this help message and exit
  --desc=STR     Group description
  --gid=INT      GID (use this option to set it manually)
  --addattr=STR  Add an attribute/value pair. Format is attr=value. The
                 attribute must be part of the schema.
  --setattr=STR  Set an attribute to a name/value pair. Format is attr=value.
                 For multi-valued attributes, the command replaces the values
                 already present.
  --rights       Display the access rights of this entry (requires --all). See
                 ipa man page for details.
  --posix        change to a POSIX group
  --all          Retrieve and print all attributes from the server. Affects
                 command output.
  --raw          Print entries as stored on the server. Only affects output
                 format.
  --rename=STR   Rename the group object


# rpm -qi ipa-server | head
Name        : ipa-server                   Relocations: (not relocatable)
Version     : 2.0.0                             Vendor: Red Hat, Inc.
Release     : 23.el6                        Build Date: Wed 20 Apr 2011 09:57:13 AM EDT
Install Date: Thu 19 May 2011 12:47:52 PM EDT      Build Host: x86-003.build.bos.redhat.com
Group       : System Environment/Base       Source RPM: ipa-2.0.0-23.el6.src.rpm
Size        : 2565882                          License: GPLv3+
Signature   : RSA/8, Thu 21 Apr 2011 03:48:25 PM EDT, Key ID 199e2f91fd431d51
Packager    : Red Hat, Inc. <http://bugzilla.redhat.com/bugzilla>
URL         : http://www.freeipa.org/
Summary     : The IPA authentication server


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