Bug 1103039

Summary: hammer "host-collection" --help should not use 'system' anymore, replace it with content-host
Product: Red Hat Satellite Reporter: Sachin Ghai <sghai>
Component: HammerAssignee: Tomas Strachota <tstrachota>
Status: CLOSED CURRENTRELEASE QA Contact: Adam Saleh <asaleh>
Severity: high Docs Contact:
Priority: unspecified    
Version: 6.0.3CC: asaleh, bkearney, jmontleo, mmccune, sthirugn, tstrachota
Target Milestone: UnspecifiedKeywords: Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
URL: http://projects.theforeman.org/issues/6092
Whiteboard:
Fixed In Version: Doc Type: Release Note
Doc Text:
Users should expect this command line API to change between Beta and GA. The --system parameter will be replaced by --content-host.
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-09-11 12:27:02 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 Sachin Ghai 2014-05-30 06:27:48 UTC
Description of problem:
Here --system and --system-id are given. May be to make it unified we should update it with --content-host.


[root@dhcp207-55 ~]# hammer host-collection content-hosts --help
Usage:
    hammer host-collection content-hosts [OPTIONS]

Options:
    --activation-key ACTIVATION_KEY_NAME  
    --activation-key-id ACTIVATION_KEY_ID  
    --id ID                       Id of the host collection
    --organization ORGANIZATION_NAME  
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL  
    --system SYSTEM_NAME           
    --system-id SYSTEM_ID          


Version-Release number of selected component (if applicable):
sat6 beta snap7 compose2 (Satellite-6.0.3-RHEL-6-20140528.4)

How reproducible:
always

Steps to Reproduce:
1.
2.
3.

Actual results:
hammer host-collection --help

Expected results:
hammer host-collection --help and for all sub-commands: the option --system or --system-id should be replaced with --content-host or --content-host-id

Additional info:

Comment 1 Sachin Ghai 2014-05-30 06:29:46 UTC
Please consider this bz for all sub-commands of "host-collection".

here also --system and --system-id is being used.

[root@dhcp207-55 ~]# hammer host-collection add-content-host --help
Usage:
    hammer host-collection add-content-host [OPTIONS]

Options:
    --id ID                        
    --name NAME                   Name to search by
    --organization ORGANIZATION_NAME  
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL  
    --system SYSTEM_NAME           
    --system-id SYSTEM_ID          
    -h, --help                    print help
[root@dhcp207-55 ~]# hammer content-host --help
Usage:
    hammer content-host [OPTIONS] SUBCOMMAND [ARG] ...

Comment 2 Sachin Ghai 2014-05-30 06:31:22 UTC
Please update this too.

[root@dhcp207-55 ~]# hammer host-collection remove-content-host --help
Usage:
    hammer host-collection remove-content-host [OPTIONS]

Options:
    --id ID                        
    --name NAME                   Name to search by
    --organization ORGANIZATION_NAME  
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL  
    --system SYSTEM_NAME           
    --system-id SYSTEM_ID          
    -h, --help                    print help

Comment 3 Sachin Ghai 2014-05-30 06:32:05 UTC
[root@dhcp207-55 ~]# hammer host-collection copy --help
Usage:
    hammer host-collection copy [OPTIONS]

Options:
    --activation-key ACTIVATION_KEY_NAME  
    --activation-key-id ACTIVATION_KEY_ID  
    --id ID                       ID of the host collection
    --name NAME                   New host collection name
    --organization ORGANIZATION_NAME  
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL  
    --system SYSTEM_NAME           
    --system-id SYSTEM_ID          
    -h, --help                    print help

Comment 4 RHEL Program Management 2014-05-30 06:55:09 UTC
Since this issue was entered in Red Hat Bugzilla, the release flag has been
set to ? to ensure that it is properly evaluated for this release.

Comment 6 sthirugn@redhat.com 2014-06-03 15:23:52 UTC
This is a usability issue - need this for beta to avoid confusion in terminologies.

Comment 7 Tomas Strachota 2014-06-06 11:46:08 UTC
Created redmine issue http://projects.theforeman.org/issues/6092 from this bug

Comment 8 Bryan Kearney 2014-06-16 22:04:07 UTC
Moving to POST since upstream bug http://projects.theforeman.org/issues/6092 has been closed

Comment 10 sthirugn@redhat.com 2014-07-25 19:16:47 UTC
Verified. 

All the system options are now removed.


*******************************************************************************
hammer> host-collection
Usage:
     host-collection [OPTIONS] SUBCOMMAND [ARG] ...

Parameters:
    SUBCOMMAND                    subcommand
    [ARG] ...                     subcommand arguments

Subcommands:
    add-content-host              Add systems to the host collection
    content-hosts                 List content hosts in the host collection
    copy                          Make copy of a host collection
    create                        Create a host collection
    delete                        Destroy a host collection
    info                          Show a host collection
    list                          List host collections
    remove-content-host           Remove systems from the host collection
    update                        Update a host collection

Options:
    -h, --help                    print help

*******************************************************************************
hammer> host-collection add-content-host --help
Usage:
     host-collection add-content-host [OPTIONS]

Options:
    --content-host-ids CONTENT_HOST_IDS Array of system ids
                                  Comma separated list of values.
    --id ID                       Id of the host collection
    --name NAME                   Host collection name to search by
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    -h, --help                    print help
*******************************************************************************
hammer> host-collection content-hosts --help
Usage:
     host-collection content-hosts [OPTIONS]

Options:
    --id ID                       Id of the host collection
    --name NAME                   Host collection name to search by
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    -h, --help                    print help

hammer> host-collection copy --help
Usage:
     host-collection copy [OPTIONS]

Options:
    --id ID                       ID of the host collection
    --name NAME                   Host collection name to search by
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    -h, --help                    print help
*******************************************************************************
hammer> host-collection create --help
Usage:
     host-collection create [OPTIONS]

Options:
    --content-host-ids CONTENT_HOST_IDS List of system uuids to be in the host collection
                                  Comma separated list of values.
    --description DESCRIPTION      
    --host-collection-ids HOST_COLLECTION_IDS Array of system ids to replace the content hosts in host collection
                                  Comma separated list of values.
    --max-content-hosts MAX_CONTENT_HOSTS Maximum number of content hosts in the host collection
    --name NAME                   Host Collection name
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    --unlimited-content-hosts UNLIMITED_CONTENT_HOSTS Whether or not the host collection may have unlimited content hosts
    -h, --help                    print help
*******************************************************************************
hammer> host-collection delete --help
Usage:
     host-collection delete [OPTIONS]

Options:
    --id ID                       Id of the host collection
    --name NAME                   Host collection name to search by
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    -h, --help                    print help

******************************************************************************
hammer> host-collection info --help
Usage:
     host-collection info [OPTIONS]

Options:
    --id ID                       Id of the host collection
    --name NAME                   Host collection name to search by
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    -h, --help                    print help
**********************************************************************************
hammer> host-collection list --help
Usage:
     host-collection list [OPTIONS]

Options:
    --activation-key ACTIVATION_KEY_NAME Activation key name to search by
    --activation-key-id ACTIVATION_KEY_ID ID of the activation key
    --by BY                       Field to sort the results on
    --content-host CONTENT_HOST_NAME Name to search by
    --content-host-id CONTENT_HOST_ID UUID of the content host
    --full-results FULL_RESULTS   Whether or not to show all results
    --name NAME                   host collection name to filter by
    --order ORDER                 Sort field and order, eg. 'name DESC'
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    --page PAGE                   Page number, starting at 1
    --per-page PER_PAGE           Number of results per page to return
    --search SEARCH               Search string
    -h, --help                    print help
************************************************************************************
hammer> host-collection remove-content-host --help
Usage:
     host-collection remove-content-host [OPTIONS]

Options:
    --content-host-ids CONTENT_HOST_IDS Array of system ids
                                  Comma separated list of values.
    --id ID                       Id of the host collection
    --name NAME                   Host collection name to search by
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    -h, --help                    print help
*******************************************************************************
hammer> host-collection update --help
Usage:
     host-collection update [OPTIONS]

Options:
    --content-host-ids CONTENT_HOST_IDS List of system uuids to be in the host collection
                                  Comma separated list of values.
    --description DESCRIPTION      
    --host-collection-ids HOST_COLLECTION_IDS Array of system ids to replace the content hosts in host collection
                                  Comma separated list of values.
    --id ID                       Id of the host collection
    --max-content-hosts MAX_CONTENT_HOSTS Maximum number of content hosts in the host collection
    --name NAME                   Host collection name to search by
    --new-name NEW_NAME           Host Collection name
    --organization ORGANIZATION_NAME Organization name to search by
    --organization-id ORGANIZATION_ID  
    --organization-label ORGANIZATION_LABEL Organization label to search by
    --unlimited-content-hosts UNLIMITED_CONTENT_HOSTS Whether or not the host collection may have unlimited content hosts
    -h, --help                    print help
*******************************************************************************

Version Tested:
* apr-util-ldap-1.3.9-3.el6_0.1.x86_64
* candlepin-0.9.19-1.el6_5.noarch
* candlepin-scl-1-5.el6_4.noarch
* candlepin-scl-quartz-2.1.5-5.el6_4.noarch
* candlepin-scl-rhino-1.7R3-1.el6_4.noarch
* candlepin-scl-runtime-1-5.el6_4.noarch
* candlepin-selinux-0.9.19-1.el6_5.noarch
* candlepin-tomcat6-0.9.19-1.el6_5.noarch
* elasticsearch-0.90.10-4.el6sat.noarch
* foreman-1.6.0.32-1.el6sat.noarch
* foreman-compute-1.6.0.32-1.el6sat.noarch
* foreman-gce-1.6.0.32-1.el6sat.noarch
* foreman-libvirt-1.6.0.32-1.el6sat.noarch
* foreman-ovirt-1.6.0.32-1.el6sat.noarch
* foreman-postgresql-1.6.0.32-1.el6sat.noarch
* foreman-proxy-1.6.0.22-1.el6sat.noarch
* foreman-selinux-1.6.0.3-1.el6sat.noarch
* foreman-vmware-1.6.0.32-1.el6sat.noarch
* katello-1.5.0-27.el6sat.noarch
* katello-ca-1.0-1.noarch
* katello-certs-tools-1.5.6-1.el6sat.noarch
* katello-installer-0.0.56-1.el6sat.noarch
* openldap-2.4.23-34.el6_5.1.x86_64
* pulp-katello-0.3-3.el6sat.noarch
* pulp-nodes-common-2.4.0-0.23.beta.el6sat.noarch
* pulp-nodes-parent-2.4.0-0.23.beta.el6sat.noarch
* pulp-puppet-plugins-2.4.0-0.23.beta.el6sat.noarch
* pulp-puppet-tools-2.4.0-0.23.beta.el6sat.noarch
* pulp-rpm-plugins-2.4.0-0.23.beta.el6sat.noarch
* pulp-selinux-2.4.0-0.23.beta.el6sat.noarch
* pulp-server-2.4.0-0.23.beta.el6sat.noarch
* python-ldap-2.3.10-1.el6.x86_64
* ruby193-rubygem-net-ldap-0.3.1-3.el6sat.noarch
* ruby193-rubygem-runcible-1.1.0-2.el6sat.noarch
* sssd-ldap-1.11.5.1-3.el6.x86_64

Comment 11 sthirugn@redhat.com 2014-07-25 19:17:32 UTC
Note: Although the system options are removed, still there are minor references to System which is documented in this https://bugzilla.redhat.com/show_bug.cgi?id=1123473

Comment 13 Bryan Kearney 2014-09-11 12:27:02 UTC
This was delivered with Satellite 6.0 which was released on 10 September 2014.