Red Hat RHSM APIs Python client implementation

This project aim is to create a client interface that using Red Hat Subscription Manager (RHSM) APIs is capable to collect a series of data from your account.

As described in the official Red Hat article Getting started with RHSM APIs in tech preview:

Using APIs in RHSM can help you more effectively keep track of and automate how you manage your Red Hat subscriptions and entitlement usage. By using APIs in RHSM, you can:

* Control which tooling you use for which products
* Better manage your system inventory
* Update and secure your systems more efficiently
* Continue receiving official support for your Red Hat products

In order to transition to using APIs for Red Hat Subscription Management, Red Hat has created a tech preview program for early access and feedback. Red Hat is in the process of decommissioning Red Hat Network (RHN), including access to its APIs. As a part of this effort, Red Hat has been developing and documenting support for RHSM.

Getting Started

Prerequisites

Red Hat Subscription Management APIs use OAuth 2.0 for authorization. For this reason rhsm-api-client uses the following libs:

• Python3 package required:

  • python3-requests-oauthlib
  • python3-oauthlib

• Python2 package required:

  • python2-requests-oauthlib
  • python2-oauthlib

Before to start script execution, you'll need the following information:

• Your Customer Portal credentials (https://access.redhat.com/)
• Client ID and Secret provided by Red Hat (https://access.redhat.com/management/api)

Installing

Installing instructions for Fedora 29:

• RPM Packages installation for Python3:

$ sudo yum install python3-oauth2client
$ sudo yum install python3-requests-oauthlib

• RPM Packages installation for Python2:

$ sudo yum install python2-oauth2client
$ sudo yum install python2-requests-oauthlib

Installing instructions for RHEL 7.6 via EPEL repos:

• Install EPEL repo rpm

If you are running an EL7 version, please visit here to get the newest 'epel-release' package for EL7: The newest version of 'epel-release' for EL7

$ sudo yum localinstall https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

• Install git

$ sudo yum install git

• Install required packages:

sudo yum install python2-oauth2client python2-requests-oauthlib

rhsm-api-client installing instructions:

• Cloning git repository:

$ git clone https://github.com/antonioromito/rhsm-api-client

Deployment

This script can be executed from your preferred path

Usage

usage: rhsm-cli [-h] [-c CLIENT_ID] [-i IDP_TOKEN_URL] -t TOKEN
                {systems,allocations,subscriptions,erratas,packages} ...

RHSM API implementation

positional arguments:
  {systems,allocations,subscriptions,erratas,packages}
                        Program mode: systems, allocations, subscriptions,
                        errata, packages)
    systems             Generate systems CSV report.
    allocations         Generate allocations CSV report.
    subscriptions       Generate subscriptions CSV report.
    erratas             Generate erratas CSV report.
    packages            Generate packages CSV report.

optional arguments:
  -h, --help            show this help message and exit

authentication:
  -c CLIENT_ID, --client_id CLIENT_ID
                        Red Hat Customer Portal OIDC client (default: rhsm-
                        api)
  -i IDP_TOKEN_URL, --idp_token_url IDP_TOKEN_URL
                        Red Hat Customer Portal SSO Token URL (default:
                        https://sso.redhat.com/auth/realms/redhat-
                        external/protocol/openid-connect/token)
  -t TOKEN, --token TOKEN
                        Red Hat Customer Portal offline token

Examples

• Generate CSV report listing all systems

Helper for "systems" CSV function provide specific instructions on the arguments that the cli expects:

$ ./rhsm-cli systems -h
usage: rhsm-cli systems [-h] -o OUTPUT_CSV [-l LIMIT]

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT_CSV, --output_csv OUTPUT_CSV
                        Output CSV file
  -l LIMIT, --limit LIMIT
                        The default and max number of result in a response are
                        100.

Here below and example of CSV report generation command line arguments usage:

$ ./rhsm-cli -t 'MyOfflineToken' systems -o /path/to/systems.csv -l 100

Offline Token Storage

Your offline token is a form of credential and should be treated securely. To help prevent your token from being exposed in your shell history or via copy/paste, you can store your token as an environment variable in your shell profile.

For example, with Bash you can add it to your ~/.bashrc file and add the following line with your token obtained from the Customer Portal:

# RHSM API Token
export RHSM_API_TOKEN=SOME_LONG_TOKEN_HERE

Then when calling your scripts, the token can be recalled via the variable:

$ ./rhsm-cli -t $RHSM_API_TOKEN systems -o /path/to/systems.csv -l 100

License

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Authors

• Antonio Romito - Initial work - rhsm-api-client

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Patrick Easters 💻

Giulia Naponiello 💻

Andrea Perotti 📓

This project follows the all-contributors specification. Contributions of any kind welcome!