RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 2121362 - 'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'
Summary: 'ansible-doc' -l lists most idm modules as 'UNDOCUMENTED'
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Enterprise Linux 8
Classification: Red Hat
Component: ansible-freeipa
Version: 8.7
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: rc
: ---
Assignee: Thomas Woerner
QA Contact: Varun Mylaraiah
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2022-08-25 09:12 UTC by Sudhir Menon
Modified: 2023-05-16 08:53 UTC (History)
3 users (show)

Fixed In Version: ansible-freeipa-1.8.4-1.el8
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-05-16 08:15:55 UTC
Type: Bug
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker FREEIPA-8686 0 None None None 2022-08-25 09:22:41 UTC
Red Hat Issue Tracker RHELPLAN-132306 0 None None None 2022-08-25 09:22:44 UTC
Red Hat Product Errata RHEA-2023:2752 0 None None None 2023-05-16 08:16:24 UTC

Description Sudhir Menon 2022-08-25 09:12:50 UTC 
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 1 Thomas Woerner 2022-08-26 11:58:44 UTC 
Which ansible version was used?
Comment 2 Thomas Woerner 2022-08-26 12:01:26 UTC 
Are only ipa modules marked as UNDOCUMENTED?
Comment 4 Thomas Woerner 2022-08-26 13:28:41 UTC 
Here is the upstream PR: https://github.com/freeipa/ansible-freeipa/pull/892
Comment 5 Rafael Jeffman 2022-08-29 14:48:27 UTC 
The upstream PR has been merged.
Comment 9 Varun Mylaraiah 2022-09-21 17:30:35 UTC 
Verified

# cat /etc/redhat-release
Red Hat Enterprise Linux release 8.8 Beta (Ootpa)

ansible-freeipa-1.8.4-1.el8.noarch


# ansible-doc -l  | grep ipa
avi_customipamdnsprofile                                      Module for setup of CustomIpamDnsProfile Avi RESTful Object
avi_ipaddrgroup                                               Module for setup of IpAddrGroup Avi RESTful Object
avi_ipamdnsproviderprofile                                    Module for setup of IpamDnsProviderProfile Avi RESTful Object
azure_rm_publicipaddress                                      Manage Azure Public IP Addresses
azure_rm_publicipaddress_info                                 Get public IP facts
ipa_config                                                    Manage Global FreeIPA Configuration Settings
ipa_dnsrecord                                                 Manage FreeIPA DNS records
ipa_dnszone                                                   Manage FreeIPA DNS Zones
ipa_group                                                     Manage FreeIPA group
ipa_hbacrule                                                  Manage FreeIPA HBAC rule
ipa_host                                                      Manage FreeIPA host
ipa_hostgroup                                                 Manage FreeIPA host-group
ipa_role                                                      Manage FreeIPA role
ipa_service                                                   Manage FreeIPA service
ipa_subca                                                     Manage FreeIPA Lightweight Sub Certificate Authorities
ipa_sudocmd                                                   Manage FreeIPA sudo command
ipa_sudocmdgroup                                              Manage FreeIPA sudo command group
ipa_sudorule                                                  Manage FreeIPA sudo rule
ipa_user                                                      Manage FreeIPA users
ipa_vault                                                     Manage FreeIPA vaults
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
ipadm_addr                                                    Manage IP addresses on an interface on Solaris/illumos systems
ipadm_addrprop                                                Manage IP address properties on Solaris/illumos systems
ipadm_if                                                      Manage IP interfaces  on Solaris/illumos systems
ipadm_ifprop                                                  Manage IP interface properties on Solaris/illumos systems
ipadm_prop                                                    Manage protocol properties on Solaris/illumos systems
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 11 errata-xmlrpc 2023-05-16 08:15:55 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:2752
Note You need to log in before you can comment on or make changes to this bug.