Bug 697215 - RHUI Manager CLI
Summary: RHUI Manager CLI
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Update Infrastructure for Cloud Providers
Classification: Red Hat
Component: Documentation
Version: 2.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Lana Brindley
QA Contact: wes hayutin
URL:
Whiteboard:
Depends On:
Blocks: 695556 701438
TreeView+ depends on / blocked
 
Reported: 2011-04-16 22:06 UTC by Jay Dobies
Modified: 2016-02-18 05:33 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
: 701438 (view as bug list)
Environment:
Last Closed: 2011-07-29 04:44:32 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Jay Dobies 2011-04-16 22:06:11 UTC
In addition to the interactive shell, a subset of that functionality is available through flags to the rhui-manager script. These commands can be seen by passing in the --help flag.



Usage: rhui-manager [options] [command]

  OPTIONS
    -h/--help  show this help message and exit
    --debug    enables debug logging
    --config   absolute path to the configuration file; defaults to /etc/rhui/rhui.conf
    --server   location of the RHUA server (overrides the config file)
    --username if specified, previously saved authentication credentials are ignored and this username is used to login
    --password used in conjunction with --username

  COMMANDS
    cert      : Red Hat content certificate management
    packages  : package manipulation on repositories
    repo      : repository listing and manipulation



Commands that begin with -- apply to both the shell and the CLI. The remainder, listed under COMMANDS, are the CLI functions.

Comment 1 Jay Dobies 2011-04-16 22:09:17 UTC
Flags:

--debug - Enables more verbose logging. The log file can be found at ~/.rhui/rhui.log

--config - If specified, RHUI Manager (shell and CLI) will use the given file instead of the default /etc/rhui/rhui-tools.conf

--server - If specified, RHUI Manager (shell and CLI) will connect to the given server instead of the server configured in the config file. Authentication credentials are stored on a per server basis, meaning this flag can be used to allow a single RHUI Manager installation to manage multiple RHUI installations.

--username, --password - If specified, these will be used to log into the RHUA. Additionally, the authentication certificate will *not* be stored when logged in in this fashion. The idea is that scripts can use this to execute CLI commands on the RHUI without needing to manage the authentication certificates.

Comment 2 Jay Dobies 2011-04-16 22:11:18 UTC
Content Certificate Management

All commands under the "cert" command are used to manipulate Red Hat content certificates.


 -> rhui-manager cert
Red Hat content certificate management
    upload - uploads a new content certificate
    info - display information about the current content certificate


- Info - Displays the same information as found in the Entitlements Screen in the shell.

- Upload - Uploads a new content certificate, updating RHUI Manager and all repositories (the same things that are done when doing this through the shell). The cert and private key are specified through flags:


 -> rhui-manager cert upload
upload: uploads a new content certificate
    --cert - full path to the new content certificate (required)
    --key - full path to the new certificate private key (required)

Comment 3 Jay Dobies 2011-04-16 22:43:15 UTC
Repo Commands

 -> rhui-manager repo
repository listing and manipulation
    list - lists all repositories in the RHUI
    info - displays information on an individual repo


- List shows all repositories in the RHUI. The important thing to note is that the IDs are displayed. The ID is needed to upload packages or view detailed repo information.


 -> rhui-manager repo list
ID                             :: Repository Name

Red Hat Respositories
---------------------
rhui-srpms-1.2-5Server-x86_64  :: Red Hat Update Infrastructure 1.2 (SRPMS) (5Server-x86_64)
rhui-srpms-1.2-5Server-i386    :: Red Hat Update Infrastructure 1.2 (SRPMS) (5Server-i386)
rhui-1.2-5Server-x86_64        :: Red Hat Update Infrastructure 1.2 (RPMs) (5Server-x86_64)
rhui-1.2-5Server-i386          :: Red Hat Update Infrastructure 1.2 (RPMs) (5Server-i386)

Custom Respositories
---------------------
repo_1                         :: Custom Repository 1






- Info - Shows detailed information on a specific repo. The --repo_id argument is required to specify the repo.



-> rhui-manager repo info --repo_id rhui-1.2-5Server-x86_64
Name:               Red Hat Update Infrastructure 1.2 (RPMs) (5Server-x86_64)
Type:               Red Hat
Relative Path:      content/dist/rhel/rhui/server/5Server/x86_64/rhui/1.2/os
Package Count:      13
Last Sync:          04-16-2011 21:58
Next Sync:          04-16-2011 23:44

Comment 4 Jay Dobies 2011-04-16 22:45:26 UTC
Packages Commands

 -> rhui-manager packages
package manipulation on repositories
    upload - uploads a package or directory of packages to a repository
    list - lists all packages in a repository


- List - Displays all packages in the repo, regardless of the number of packages.

 -> rhui-manager packages list --repo_id rhui-1.2-5Server-x86_64
PyYAML-3.08-4.el5.x86_64.rpm
grinder-0.0.57-1.el5.noarch.rpm
httpd-2.2.3-43.el5_5.3.x86_64.rpm
libyaml-0.1.2-3.el5.x86_64.rpm
m2crypto-0.16-6.1.el5_5.1.x86_64.rpm
mod_python-3.3.1-12.el5.x86_64.rpm
python-hashlib-20081119-5.el5.x86_64.rpm
python-pycurl-7.15.5.1-4.el5.x86_64.rpm
rh-cds-0.27-1.el5_5.noarch.rpm
rh-rhua-0.91-1.el5_5.noarch.rpm
rh-rhua-0.95-1.el5_5.noarch.rpm
rh-rhui-tools-0.76-1.el5_5.noarch.rpm
rpm-build-4.4.2.3-20.el5_5.1.x86_64.rpm



- Upload - Functions similar to how it does in the shell, allowing a single package or a directory of packages to be uploaded. The --repo_id and --packages arguments are both required.


upload: uploads a package or directory of packages to a repository
    --repo_id - id of the repository where the packages will be uploaded (required)
    --packages - path to an .rpm file or directory of RPMs that will be uploaded (required)

Comment 5 Lana Brindley 2011-04-17 23:13:21 UTC
Operation/The RHUI Manager

LKB

Comment 6 Jay Dobies 2011-04-18 18:21:11 UTC
New command added:

    status    : RHUI status and health information

Outputs a short summary of whether or not CDS instances are running. If --code is specified, simply outputs a numeric code to reflect the state of the RHUI (0 means everything is ok, non-zero means one or more CDS instances are down).



Samples:

-> rhui-manager status
US East Region CDS .......................................... [  UP  ]

 -> rhui-manager status --code
0

Comment 7 Lana Brindley 2011-05-02 04:02:04 UTC
(In reply to comment #3)

Hi Jay,

Just working on this section, and noticed the "Respositories" typos (below). Want me to raise another bug for that?

> 
>  -> rhui-manager repo list
> ID                             :: Repository Name
> 
> Red Hat Respositories
> ---------------------
> rhui-srpms-1.2-5Server-x86_64  :: Red Hat Update Infrastructure 1.2 (SRPMS)
> (5Server-x86_64)
> rhui-srpms-1.2-5Server-i386    :: Red Hat Update Infrastructure 1.2 (SRPMS)
> (5Server-i386)
> rhui-1.2-5Server-x86_64        :: Red Hat Update Infrastructure 1.2 (RPMs)
> (5Server-x86_64)
> rhui-1.2-5Server-i386          :: Red Hat Update Infrastructure 1.2 (RPMs)
> (5Server-i386)
> 
> Custom Respositories
> ---------------------
> repo_1                         :: Custom Repository 1
> 

LKB

Comment 8 Jay Dobies 2011-05-02 12:55:58 UTC
Yes, please create another bug on that. And thanks for the heads up, with as much as we talk about "certificates" you'd be scared how many times I mistype that word too.

Comment 9 Lana Brindley 2011-05-02 21:58:44 UTC
Revision 1-2

LKB

Comment 10 Kedar Bidarkar 2011-05-24 10:50:32 UTC
RHUI Manager CLI options is now covered in the docs.

Comment 11 Lana Brindley 2011-07-29 04:44:32 UTC
This book is now available at http://docs.redhat.com/docs/en-US/Red_Hat_Update_Infrastructure/2.0/html/Installation_Guide/index.html

Please raise a new bug for any further changes.

LKB


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