Bug 1733573 - hypervisor ID command argument incorrectly shown
Summary: hypervisor ID command argument incorrectly shown
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite 6
Classification: Red Hat
Component: Documentation
Version: Unspecified
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified vote
Target Milestone: 6.7.0
Assignee: Sergei Petrosian
QA Contact: Tahlia Richardson
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-07-26 14:58 UTC by Stephen Wadeley
Modified: 2019-12-05 12:16 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-12-05 12:16:35 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Stephen Wadeley 2019-07-26 14:58:11 UTC
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_satellite/6.5/html/virtual_instances_guide/configuring-virt-who#creating-virt-who-configuration-with-hammer


Section Number and Name: 
3.2. Creating virt-who Configuration using Hammer

Describe the issue: 

--hypervisor-id hostname \ 5    <-- Notice hostname is in italics, the traditional way to render a replaceable value, but its confusing as it must be one of three literal values.

5
    Specifies how the hypervisor will be identified. Possible values: hostname, uuid, hwuuid. Recommended: hostname. 


That command argument is a literal, not replaceable, but as there are more than one you cannot just put one marked up as a literal.

Suggestions for improvement: 

s|hypervisor-id hostname|hypervisor-id __hypervisor_id__|

Additional information: 

    [root@dell-r330-12 ~]# hammer virt-who-config create -h
    Usage:
        hammer virt-who-config create [OPTIONS]
     
    Options:
     --blacklist BLACKLIST                     Hypervisor blacklist, applicable only when filtering mode is set to 2.
                                               Wildcards and regular expressions are supported, multiple records must be
                                               Separated by comma.
     --debug DEBUG                             Enable debugging output
                                               One of true/false, yes/no, 1/0.
     --filtering-mode MODE                     Hypervisor filtering mode
                                               Possible value(s): 'none', 'whitelist', 'blacklist'
     --hypervisor-id HYPERVISOR_ID             Specifies how the hypervisor will be identified.
                                               Possible value(s): 'hostname', 'uuid', 'hwuuid


Note You need to log in before you can comment on or make changes to this bug.