Bug 2125603

Summary: 'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'
Product: Red Hat Enterprise Linux 9 Reporter: Thomas Woerner <twoerner>
Component: ansible-freeipaAssignee: Thomas Woerner <twoerner>
Status: CLOSED ERRATA QA Contact: Varun Mylaraiah <mvarun>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 9.2CC: mvarun
Target Milestone: rcKeywords: Triaged
Target Release: ---Flags: pm-rhel: mirror+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ansible-freeipa-1.8.4-1.el9 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2023-05-09 07:25:35 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 Thomas Woerner 2022-09-09 12:28:09 UTC
This bug was initially created as a copy of Bug #2121362

I am copying this bug because: 



Description of problem: 'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'

Version-Release number of selected component (if applicable):
ansible-freeipa-1.8.3-1.el8.noarch

How reproducible: Always

Steps to Reproduce:
1. Install ansible-freipa
2. Run ansible-doc -l  | grep ipa

Actual results:
[root@controller ~]# ansible-doc -l | grep ipa
ipaautomember              UNDOCUMENTED                                    
ipaautomountkey            Manage FreeIPA autommount map                   
ipaautomountlocation       Manage FreeIPA autommount locations             
ipaautomountmap            Manage FreeIPA autommount map                   
ipaconfig                  Modify IPA global config options                
ipadelegation              UNDOCUMENTED                                    
ipadnsconfig               UNDOCUMENTED                                    
ipadnsforwardzone          Manage FreeIPA DNS Forwarder Zones              
ipadnsrecord               UNDOCUMENTED                                    
ipadnszone                 UNDOCUMENTED                                    
ipagroup                   UNDOCUMENTED                                    
ipahbacrule                UNDOCUMENTED                                    
ipahbacsvc                 UNDOCUMENTED                                    
ipahbacsvcgroup            UNDOCUMENTED                                    
ipahost                    UNDOCUMENTED                                    
ipahostgroup               UNDOCUMENTED                                    
ipaidrange                 UNDOCUMENTED                                    
ipalocation                UNDOCUMENTED                                    
ipapermission              UNDOCUMENTED                                    
ipaprivilege               UNDOCUMENTED                                    
ipapwpolicy                UNDOCUMENTED                                    
iparole                    UNDOCUMENTED                                    
ipaselfservice             UNDOCUMENTED                                    
ipaserver                  UNDOCUMENTED                                    
ipaservice                 UNDOCUMENTED                                    
ipaservicedelegationrule   UNDOCUMENTED                                    
ipaservicedelegationtarget UNDOCUMENTED                                    
ipasudocmd                 UNDOCUMENTED                                    
ipasudocmdgroup            UNDOCUMENTED                                    
ipasudorule                UNDOCUMENTED                                    
ipatopologysegment         UNDOCUMENTED                                    
ipatopologysuffix          UNDOCUMENTED                                    
ipatrust                   Manage FreeIPA Domain Trusts                    
ipauser                    UNDOCUMENTED                                    
ipavault                   UNDOCUMENTED  

Expected results:
UNDOCUMENTED should be replaced with meaningful information.

Additional info:

Comment 4 Varun Mylaraiah 2022-09-22 14:03:11 UTC
Verified

ansible-freeipa-1.8.4-1.el9.noarch

# cat /etc/redhat-release
Red Hat Enterprise Linux release 9.2 Beta (Plow)

# ansible-doc -l  | grep ipa
ipaautomember              Add and delete FreeIPA Auto Membership Rules
ipaautomountkey            Manage FreeIPA autommount map
ipaautomountlocation       Manage FreeIPA autommount locations
ipaautomountmap            Manage FreeIPA autommount map
ipaconfig                  Modify IPA global config options
ipadelegation              Manage FreeIPA delegations
ipadnsconfig               Manage FreeIPA dnsconfig
ipadnsforwardzone          Manage FreeIPA DNS Forwarder Zones
ipadnsrecord               Manage FreeIPA DNS records
ipadnszone                 Manage FreeIPA dnszone
ipagroup                   Manage FreeIPA groups
ipahbacrule                Manage FreeIPA HBAC rules
ipahbacsvc                 Manage FreeIPA HBAC Services
ipahbacsvcgroup            Manage FreeIPA hbacsvcgroups
ipahost                    Manage FreeIPA hosts
ipahostgroup               Manage FreeIPA hostgroups
ipaidrange                 Manage FreeIPA idrange
ipalocation                Manage FreeIPA location
ipapermission              Manage FreeIPA permission
ipaprivilege               Manage FreeIPA privilege
ipapwpolicy                Manage FreeIPA pwpolicies
iparole                    Manage FreeIPA role
ipaselfservice             Manage FreeIPA selfservices
ipaserver                  Manage FreeIPA server
ipaservice                 Manage FreeIPA service
ipaservicedelegationrule   Manage FreeIPA servicedelegationrule
ipaservicedelegationtarget Manage FreeIPA servicedelegationtarget
ipasudocmd                 Manage FreeIPA sudo command
ipasudocmdgroup            Manage FreeIPA sudocmd groups
ipasudorule                Manage FreeIPA sudo rules
ipatopologysegment         Manage FreeIPA topology segments
ipatopologysuffix          Verify FreeIPA topology suffix
ipatrust                   Manage FreeIPA Domain Trusts
ipauser                    Manage FreeIPA users
ipavault                   Manage vaults and secret vaults


Based on the above observation, marking the bug VERIFIED

Comment 6 errata-xmlrpc 2023-05-09 07:25:35 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 (ansible-freeipa bug fix and enhancement update), and where to find the updated
files, follow the link below.

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

https://access.redhat.com/errata/RHEA-2023:2168