Bug 1856832

Summary: man page entry missing for "--org" option under "ROLE OPTIONS" "USAGE OPTIONS" "ADDONS OPTIONS"
Product: Red Hat Enterprise Linux 8 Reporter: Archana Pandey <arpandey>
Component: subscription-managerAssignee: candlepin-bugs
Status: CLOSED ERRATA QA Contact: Red Hat subscription-manager QE Team <rhsm-qe>
Severity: low Docs Contact:
Priority: medium    
Version: 8.3CC: jsefler, redakkan
Target Milestone: rcKeywords: EasyFix, Triaged
Target Release: 8.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: subscription-manager-1.28.15-1.el8 Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2021-11-09 19:37:33 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 Archana Pandey 2020-07-14 14:26:00 UTC 
Description of problem:
man page entry missing for "--org" option from  "ROLE OPTIONS" "USAGE OPTIONS" "ADDONS OPTIONS" 


Version-Release number of selected component (if applicable):
[root@ibm-x3650m4-01-vm-08 ~]# subscription-manager version
server type: This system is currently not registered.
subscription management server: 3.1.15-1
subscription management rules: 5.40
subscription-manager: 1.27.9-1.git.1.5ce543e.el8


How reproducible:


Steps to Reproduce:
[root@ibm-x3650m4-01-vm-08 ~]# man subscription-manager | grep "ROLE OPTION" -A 22
   ROLE OPTIONS
       The  role  command displays the current configured role preference for products installed on the system. For example, if the role preference is "Red Hat Enterprise Linux Server", then a subscription
       with a "Red Hat Enterprise Linux Server" role is selected when auto-attaching subscriptions to the system.

       --show Shows the system's current role preference. If a role is not set, then there is a message saying it is not set.

       --list Lists the available role system purpose values.

       --username=USERNAME
              Gives the username for the account to use to connect to the organization account [Use with --list when unregistered].

       --password=PASSWORD
              Gives the user account password [Use with --list when unregistered].

       --token=TOKEN
              Token to use when authorizing against the server [Use with --list when unregistered].

       --set=ROLE
              Role to apply to this system

       --unset
              Removes any previously set role preference.

  
Note: Same is case for "USAGE OPTION" and "ADDONS OPTION"

Actual results:
--org is missing from option list

Expected Result:
--org should be listed in options
Comment 2 Tiffany Merry 2021-03-15 20:42:55 UTC 
Please review the wording and provide feedback
Comment 3 Tiffany Merry 2021-03-15 20:45:28 UTC 
To Test:

man man/subscription-manager/subscription-manager.8
Comment 5 Archana Pandey 2021-04-27 11:39:24 UTC 
verifying issue on subscription-manager-1.28.16-1.el8.x86_64

verification steps:

[root@hpe-dl380pgen8-02-vm-8 ~]# subscription-manager version
server type: This system is currently not registered.
subscription management server: 3.2.16-1
subscription management rules: 5.41
subscription-manager: 1.28.16-1.el8

[root@hpe-dl380pgen8-02-vm-8 ~]# rpm -qa --changelog subscription-manager | grep 1856832
- 1856832: add --org=ORG to the ROLE OPTIONS, USAGE OPTIONS and ADDONS OPTIONS
- 1856832: add --org=ORG to the ROLE OPTIONS, USAGE OPTIONS and ADDONS OPTIONS

[root@hpe-dl380pgen8-02-vm-8 ~]# man subscription-manager | grep "ROLE OPTION" -A 24
   ROLE OPTIONS
       The  role  command displays the current configured role preference for products installed on the system. For example, if the role preference is "Red Hat Enterprise Linux Server", then a subscription
       with a "Red Hat Enterprise Linux Server" role is selected when auto-attaching subscriptions to the system.

       --show Shows the system's current role preference. If a role is not set, then there is a message saying it is not set.

       --list Lists the available role system purpose values.

       --username=USERNAME
              Gives the username for the account to use to connect to the organization account [Use with --list when unregistered].

       --password=PASSWORD
              Gives the user account password [Use with --list when unregistered].

       --token=TOKEN
              Token to use when authorizing against the server [Use with --list when unregistered].

       --set=ROLE
              Role to apply to this system

       --unset
              Removes any previously set role preference.

       --org=ORG
              Identifies the organization for which the role applies.   <<<< --org added


[root@hpe-dl380pgen8-02-vm-8 ~]# man subscription-manager | grep "USAGE OPTION" -A 24
   USAGE OPTIONS
       The usage command displays the current configured usage preference for products installed on the system. For example, if the usage preference is "Production", then a subscription with a "Production"
       usage is selected when auto-attaching subscriptions to the system.

       --show Shows the system's current usage preference. If a usage is not set, then there is a message saying it is not set.

       --list Lists the available usage system purpose values.

       --username=USERNAME
              Gives the username for the account to use to connect to the organization account [Use with --list when unregistered].

       --password=PASSWORD
              Gives the user account password [Use with --list when unregistered].

       --token=TOKEN
              Token to use when authorizing against the server [Use with --list when unregistered].

       --set=USAGE
              Usage to apply to this system

       --unset
              Removes any previously set usage preference.

       --org=ORG
              Identifies the organization for which the usage applies.     <<<<<<<<<< --org added


[root@hpe-dl380pgen8-02-vm-8 ~]# man subscription-manager | grep "ADDONS OPTION" -A 28
   ADDONS OPTIONS
       The addons command displays the current configured addons system purpose attribute preference for products installed on the system. For example, if the addons preference is ADDON1, then a  subscrip‐
       tion with a ADDON1 addon is selected when auto-attaching subscriptions to the system.

       --show Shows the system's current addons preference. If a addons is not set, then there is a message saying it is not set.

       --list Lists the available addons system purpose values.

       --username=USERNAME
              Gives the username for the account to use to connect to the organization account [Use with --list when unregistered].

       --password=PASSWORD
              Gives the user account password [Use with --list when unregistered].

       --token=TOKEN
              Token to use when authorizing against the server [Use with --list when unregistered].

       --add=ADDON
              Addon to add to the list of requested addons for this system

       --remove=ADDON
              Remove the addon from the list of requested addons.

       --unset
              Removes all addons from the list of requested addons.

       --org=ORG
              Identifies the organization for which the addons applies.  <<< --org for addons added

Verified : --org has been added to man page for "ROLE", "USAGE", "ADDONS" options
Comment 9 Rehana 2021-05-17 11:03:38 UTC 
Verifying :
# subscription-manager version
server type: Red Hat Subscription Management
subscription management server: 3.2.18-1
subscription management rules: 5.41
subscription-manager: 1.28.16-1.el8

# rpm -qa --changelog subscription-manager | grep 1856832
- 1856832: add --org=ORG to the ROLE OPTIONS, USAGE OPTIONS and ADDONS OPTIONS
- 1856832: add --org=ORG to the ROLE OPTIONS, USAGE OPTIONS and ADDONS OPTIONS

# ADDONS OPTIONS
The addons command displays the current configured addons system purpose attribute preference for products installed on the system. For example, if the addons preference is ADDON1, then a subscrip‐
tion with a ADDON1 addon is selected when auto-attaching subscriptions to the system.

  <snip>
   --org=ORG
              Identifies the organization for which the addons applies.

ROLE OPTIONS
The  role command displays the current configured role preference for products installed on the system. For example, if the role preference is "Red Hat Enterprise Linux Server", then a subscription
with a "Red Hat Enterprise Linux Server" role is selected when auto-attaching subscriptions to the system.

<snip>

       --org=ORG
              Identifies the organization for which the role applies
USAGE OPTIONS
The  usage  command  displays the current configured usage preference for products installed on the system. For example, if the usage preference is "Production", then a subscription with a "Produc‐
tion" usage is selected when auto-attaching subscriptions to the system.
<snip>
       --org=ORG
              Identifies the organization for which the usage applies.

^^As shown above, --org option as been added to ROLE/USAGE/ADDONS section. 

Moving the bug to Verified!
Comment 12 errata-xmlrpc 2021-11-09 19:37:33 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 (subscription-manager 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/RHBA-2021:4390