第1章 はじめに

Red Hat Satellite には Representational State Transfer (REST) API が含まれています。ソフトウェア開発者やシステム管理者は、この API を使用することで、標準の Web インターフェース以外で Red Hat Satellite 環境を制御できるようになります。REST API は、Red Hat Satellite の機能と、HTTP 経由で API にアクセスする外部アプリケーションやカスタムスクリプトを統合することを目的とする開発者や管理者には便利です。

1.1. Red Hat Satellite API の概要

REST API の使用すると、以下のようなメリットがあります。

  • 幅広いクライアントサポート: HTTP プロトコルをサポートする各種プログラミング言語、フレームワークまたはシステムで API を使用できます。
  • 自己記述型: 詳しい情報の多くはランタイム時に確認できるので、クライアントアプリケーションでは、必要な Red Hat Satellite インフラストラクチャーの情報は最小限で済みます。
  • リソースベースのモデル: リソースベースの REST モデルにより仮想化プラットフォームを自然な形で管理することが可能です。

REST API を使用して、以下のタスクを実行できます。

  • エンタープライズ IT システムとの統合
  • サードパーティー製のアプリケーションとの統合
  • 自動メンテナンスやエラーチェックなどのタスクの実行
  • スクリプトによる反復タスクの自動化

Satellite Server のアップグレードを準備する時に、使用するスクリプトに含まれる Satellite API コマンドが最新であることを確認してください。API コマンドは、Satellite のバージョンごとに異なります。API の変更点に関する情報は、Red Hat カスタマーポータルのナレッジベースアーティクル「API Changes Between Satellite Versions」を参照してください。

1.2. Hammer CLI ツールと Satellite API の比較

多くのタスクで、Hammer および Satellite API の両方を使用できます。Satellite API を人間でも簡単に使用できるように、Hammer をインターフェースとして使用できます。Satellite API への使いやすいインターフェースとして使用できます。たとえば、API 呼び出しへの応答をテストしてからスクリプトに適用するには、--debug オプションを使用して対象の Hammer の問題 (hammer --debug organization list) が含まれる API 呼び出しを検出します。

各 Hammer コマンドはバックグラウンドで、先に API へのバインディングを確立してから要求を送信します。この動作は、大量の Hammer コマンドを順に実行する場合に、パフォーマンスに影響を与える可能性があります。一方、API コマンドを使用するスクリプトは、Satellite API と直接通信します。

Hammer コマンドは API の変更を自動的に反映しますが、API コマンドを使用するスクリプトは手動で更新する必要がある点に注意してください。詳細情報は、『Hammer CLI ガイド』を参照してください。