Project

General

Profile

Bug #31597

The "hammer auth-source ldap update" command's "--host" argument does not have an appropriate explanation for it

Added by Oleh Fedorenko 9 months ago. Updated 7 months ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
-
Difficulty:
trivial
Triaged:
No
Bugzilla link:
Fixed in Releases:
Found in Releases:

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1911338

Description of problem:

The "hammer auth-source ldap update" command's "--host" argument does not have an appropriate explanation for it. It is used to update the "server" value in the auth-source configuration which causes confusion.

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

Satellite 6.6, 6.7, and 6.8.

How reproducible:

Always.

Steps to Reproduce:

1. Create any auth-source configuration in Red Hat Satellite.
2. List the auth-source using hammer command: # hammer auth-source ldap info --name <auth-source_config_name>
3. Now to change the "Server" parameter for the auth-source configuration you will have to use following command:

  1. hammer auth-source ldap update --name <auth-source_config_name> --host <new_server_name>

Actual results:

The "Server" for the desired auth-source configuration can be changed using the "--host" argument.

And there is no explanation for the "--host" argument stating it's usage:

---
[root@sat1 ~]# hammer auth-source ldap update --help
Usage:
hammer auth-source ldap update [OPTIONS]

Options:
--account ACCOUNT
--account-password ACCOUNT_PASSWORD Required if onthefly_register is true
--attr-firstname ATTR_FIRSTNAME Required if onthefly_register is true
--attr-lastname ATTR_LASTNAME Required if onthefly_register is true
--attr-login ATTR_LOGIN Required if onthefly_register is true
--attr-mail ATTR_MAIL Required if onthefly_register is true
--attr-photo ATTR_PHOTO
--base-dn BASE_DN
--groups-base GROUPS_BASE Groups base DN
--host HOST
--id ID
--ldap-filter LDAP_FILTER LDAP filter
---

Expected results:

Either there should be an explanation for the "--host" argument stating that its usage is to modify the "Server" parameter in the desired auth-source config file or the "--host" argument should be replaced by the "--server" argument which is identical to the "Server" filed and easy to understand/interpret.

Additional info:

Associated revisions

Revision 98eb42ee (diff)
Added by Adi Abramovitch 7 months ago

Fixes #31597 - Add description for host param in LDAP

History

#1 Updated by Oleh Fedorenko 9 months ago

  • Difficulty set to trivial
  • Category changed from 19 to API

#2 Updated by Oleh Fedorenko 9 months ago

To fix this I'd suggest to simply add a description for the host parameter.

#3 Updated by yifat makias 7 months ago

  • Assignee set to Adi Abramovitch

#4 Updated by The Foreman Bot 7 months ago

  • Status changed from New to Ready For Testing
  • Pull request https://github.com/theforeman/foreman/pull/8357 added

#5 Updated by The Foreman Bot 7 months ago

  • Fixed in Releases 2.5.0 added

#6 Updated by Adi Abramovitch 7 months ago

  • Status changed from Ready For Testing to Closed

Also available in: Atom PDF