Bug 697009

Summary: ipa-replica-manage: man page and help pages do not match
Product: Red Hat Enterprise Linux 6 Reporter: Jenny Severance <jgalipea>
Component: ipaAssignee: Rob Crittenden <rcritten>
Status: CLOSED ERRATA QA Contact: Chandrasekar Kannan <ckannan>
Severity: low Docs Contact:
Priority: unspecified    
Version: 6.1CC: benl, dpal, grajaiya
Target Milestone: rc   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ipa-2.1.0-1.el6 Doc Type: Bug Fix
Doc Text:
Do not document
Story Points: ---
Clone Of: Environment:
Last Closed: 2011-12-06 18:21:43 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description Jenny Severance 2011-04-15 15:07:37 UTC
Description of problem:
MAN PAGE:

pa-replica-manage(1)                                    ipa-replica-manage(1)

NAME
       ipa-replica-manage - Manage an IPA replica

SYNOPSIS
       ipa-replica-manage [OPTION]...  [connect|disconnect|del|list|re-initialize|force-sync]

DESCRIPTION
       Manages the replication agreements of an IPA server.

       connect [SERVER_A] <SERVER_B>
              - Adds a new replication agreement between SERVER_A/localhost and SERVER_B

       disconnect [SERVER_A] <SERVER_B>
              - Removes a replication agreement between SERVER_A/localhost and SERVER_B

       del <SERVER>
              - Removes all replication agreements and data about SERVER

       list [SERVER]
              - Lists all the servers or the list of agreements of SERVER

       re-initialize
              - Forces a full re-initialization of the IPA server retrieving data from the server specified with the --from option

       force-sync
              - Immediately flush any data to be replicated from a server specified with the --from option

OPTIONS
       -H HOST, --host=HOST
              The IPA server to manage.  The default is the machine on which the command is run Not honoured by the re-initialize command.

       -p DM_PASSWORD, --password=DM_PASSWORD
              The Directory Manager password to use for authentication

       -v, --verbose
              Provide additional information

       --winsync
              Specifies to create/use a Windows Sync Agreement

       --binddn=ADMIN_DN
              Bind DN to use with remote server (default is cn=Directory Manager) - Be careful to quote this value on the command line

       --cacert=/path/to/cacertfile
              Full  path  and  filename  of  CA  certificate  to use with TLS/SSL to the remote server - this CA certificate will be installed in the directory
              server’s certificate database

       --win-subtree=cn=Users,dc=example,dc=com
              DN of Windows subtree containing the users you want to sync (default cn=Users,<domain suffix> - this is typically what Windows  AD  uses  as  the
              default value) - Be careful to quote this value on the command line

       --passsync=PASSSYNC_PWD
              Password for the Windows PassSync user.

       --from=SERVER
              The server to pull the data from, used by the re-initialize and force-sync commands.

EXAMPLES
       List all masters:
               # ipa-replica-manage list
               srv1.example.com
               srv2.example.com
               srv3.example.com
               srv4.example.com

       List a server’s replication agreements.
               # ipa-replica-manage list srv1.example.com
               srv2.example.com
               srv3.example.com

       Re-initialize a replica:
               # ipa-replica-manage re-initialize --from srv2.example.com

              This will re-initialize the data on the server where you execute the command, retrieving the data from the srv2.example.com replica

       Add a new replication agreement:
               # ipa replica-manage connect srv2.example.com srv4.example.com

       Remove an existing replication agreement:
               # ipa replica-manage disconnect srv1.example.com srv3.example.com

       Completely remove a replica:
               # ipa replica-manage del srv4.example.com

       Using connect/disconnect you can manage the replication topology.

EXIT STATUS
        0 if the command was successful
        1 if an error occurred


HELP:

]# ipa-replica-manage --help
Usage: ipa-replica-manage [options]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -H HOST, --host=HOST  starting host
  -p DIRMAN_PASSWD, --password=DIRMAN_PASSWD
                        Directory Manager password
  -v, --verbose         provide additional information
  -f, --force           ignore some types of errors
  --binddn=BINDDN       Bind DN to use with remote server
  --bindpw=BINDPW       Password for Bind DN to use with remote server
  --winsync             This is a Windows Sync Agreement
  --cacert=CACERT       Full path and filename of CA certificate to use with
                        TLS/SSL to the remote server
  --win-subtree=WIN_SUBTREE
                        DN of Windows subtree containing the users you want to
                        sync (default cn=Users,<domain suffix)
  --passsync=PASSSYNC   Password for the Windows PassSync user
  --from=FROMHOST       Host to get data from


Which is correct?

Version-Release number of selected component (if applicable):
ipa-server-2.0.0-20.el6.x86_64

How reproducible:
always

Steps to Reproduce:
1. install ipa-server
2. man ipa-replica-manage
3. ipa-replica-manage --help
  
Actual results:
Big difference in output

Expected results:
At least the same (correct) options and flags should be listed in both

Additional info:

Comment 2 Dmitri Pal 2011-04-15 16:16:12 UTC
https://fedorahosted.org/freeipa/ticket/1178

Comment 4 Rob Crittenden 2011-08-01 20:36:56 UTC
master: 9de10f3674078ef8c423522e30fe704a2d09a7c2

ipa-2-0: 9a3bf577f831d3595cef6013cd319e3a4db03d1e

Comment 6 Rob Crittenden 2011-10-31 17:52:37 UTC
    Technical note added. If any revisions are required, please edit the "Technical Notes" field
    accordingly. All revisions will be proofread by the Engineering Content Services team.
    
    New Contents:
Do not document

Comment 7 Gowrishankar Rajaiyan 2011-11-03 10:44:47 UTC
[root@qe-blade-12 ~]# ipa-replica-manage --help
Usage: ipa-replica-manage [options]

Options:
  --version             show program's version number and exit
  -h, --help            show this help message and exit
  -H HOST, --host=HOST  starting host
  -p DIRMAN_PASSWD, --password=DIRMAN_PASSWD
                        Directory Manager password
  -v, --verbose         provide additional information
  -f, --force           ignore some types of errors
  --binddn=BINDDN       Bind DN to use with remote server
  --bindpw=BINDPW       Password for Bind DN to use with remote server
  --winsync             This is a Windows Sync Agreement
  --cacert=CACERT       Full path and filename of CA certificate to use with
                        TLS/SSL to the remote server
  --win-subtree=WIN_SUBTREE
                        DN of Windows subtree containing the users you want to
                        sync (default cn=Users,<domain suffix)
  --passsync=PASSSYNC   Password for the Windows PassSync user
  --from=FROMHOST       Host to get data from
[root@qe-blade-12 ~]#

from man:

OPTIONS
       -H HOST, --host=HOST
              The IPA server to manage.  The default is the machine on which the command is run Not honoured by the re-initialize command.

       -p DM_PASSWORD, --password=DM_PASSWORD
              The Directory Manager password to use for authentication

       -v, --verbose
              Provide additional information

       -f, --force
              Ignore some types of errors

       --binddn=ADMIN_DN
              Bind DN to use with remote server (default is cn=Directory Manager) - Be careful to quote this value on the command line

       --bindpw=ADMIN_PWD
              Password for Bind DN to use with remote server (default is the DM_PASSWORD above)

       --winsync
              Specifies to create/use a Windows Sync Agreement

       --cacert=/path/to/cacertfile
              Full  path  and  filename  of  CA  certificate to use with TLS/SSL to the remote server - this CA certificate will be installed in the
              directory server’s certificate database

       --win-subtree=cn=Users,dc=example,dc=com
              DN of Windows subtree containing the users you want to sync (default cn=Users,<domain suffix> - this is typically what Windows AD uses
              as the default value) - Be careful to quote this value on the command line

       --passsync=PASSSYNC_PWD
              Password for the Windows PassSync user. Required when using --winsync. This does not mean you have to use the PassSync service.

       --from=SERVER
              The server to pull the data from, used by the re-initialize and force-sync commands.



Verified in version:
Name        : ipa-server                   Relocations: (not relocatable)
Version     : 2.1.3                             Vendor: Red Hat, Inc.
Release     : 8.el6                         Build Date: Wed 02 Nov 2011 03:21:27 AM IST
Install Date: Thu 03 Nov 2011 10:13:53 AM IST      Build Host: x86-012.build.bos.redhat.com
Group       : System Environment/Base       Source RPM: ipa-2.1.3-8.el6.src.rpm
Size        : 3381421                          License: GPLv3+
Signature   : (none)
Packager    : Red Hat, Inc. <http://bugzilla.redhat.com/bugzilla>
URL         : http://www.freeipa.org/
Summary     : The IPA authentication server

Comment 8 errata-xmlrpc 2011-12-06 18:21:43 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

http://rhn.redhat.com/errata/RHSA-2011-1533.html