第6章 API チートシート

Red Hat Satellite API を使用してさまざまなタスクを実行する方法は、次の例を参照してください。ポート 443 の HTTPS 経由で Satellite Server 上の API を使用できます。

たとえば、Ruby では、Satellite Server の URL を次のように指定できます。

url = 'https://satellite.example.com/api/v2/'
katello_url = 'https://satellite.example.com/katello/api/v2/'

url = 'https://satellite.example.com/api/v2/'
katello_url = 'https://satellite.example.com/katello/api/v2/'

Copy to Clipboard

Toggle word wrap

これらの値を使用してスクリプトを完全に自動化し、使用するポートを検証する必要性をなくします。

次の例では、API リクエストの送信に curl を使用します。詳細は、「curl での API の呼び出し」を参照してください。

6.1. ホストの使用方法
リンクのコピー

6.1.1. ホストのリスト表示
リンクのコピー

この例では、登録されたホストの一覧を返します。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts \
| python3 -m json.tool

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

API 応答

{
      ...
       "total" => 2,
    "subtotal" => 2,
        "page" => 1,
    "per_page" => 1000,
      "search" => nil,
        "sort" => {
           "by" => nil,
        "order" => nil
    },
     "results" => [
      ...
}

{
      ...
       "total" => 2,
    "subtotal" => 2,
        "page" => 1,
    "per_page" => 1000,
      "search" => nil,
        "sort" => {
           "by" => nil,
        "order" => nil
    },
     "results" => [
      ...
}

Copy to Clipboard

Toggle word wrap

6.1.2. ホストの情報要求
リンクのコピー

この要求は、satellite.example.com ホストの情報を返します。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts/satellite.example.com \
| python3 -m json.tool

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts/satellite.example.com \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

API 応答

{
    "all_puppetclasses": [],
    "architecture_id": 1,
    "architecture_name": "x86_64",
    "build": false,
    "capabilities": [
        "build"
    ],
    "certname": "satellite.example.com",
    "comment": null,
    "compute_profile_id": null,
    ...
}

{
    "all_puppetclasses": [],
    "architecture_id": 1,
    "architecture_name": "x86_64",
    "build": false,
    "capabilities": [
        "build"
    ],
    "certname": "satellite.example.com",
    "comment": null,
    "compute_profile_id": null,
    ...
}

Copy to Clipboard

Toggle word wrap

6.1.3. ホストのファクト表示
リンクのコピー

この要求は、satellite.example.com ホストの全ファクトを返します。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts/satellite.example.com/facts \
| python3 -m json.tool

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts/satellite.example.com/facts \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

API 応答

{
    ...
    "results": {
        "satellite.example.com": {
            "augeasversion": "1.0.0",
            "bios_release_date": "01/01/2007",
            "bios_version": "0.5.1",
            "blockdevice_sr0_size": "1073741312",
            "facterversion": "1.7.6",
            ...
}

{
    ...
    "results": {
        "satellite.example.com": {
            "augeasversion": "1.0.0",
            "bios_release_date": "01/01/2007",
            "bios_version": "0.5.1",
            "blockdevice_sr0_size": "1073741312",
            "facterversion": "1.7.6",
            ...
}

Copy to Clipboard

Toggle word wrap

6.1.4. パターンが一致するホストの検索
リンクのコピー

以下のクエリーは、"example" というパターンと一致するホストをすべて返します。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts?search=example \
| python3 -m json.tool

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts?search=example \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

API 応答

{
    ...
    "results": [
        {
            "name": "satellite.example.com",
            ...
        }
    ],
    "search": "example",
    ...
}

{
    ...
    "results": [
        {
            "name": "satellite.example.com",
            ...
        }
    ],
    "search": "example",
    ...
}

Copy to Clipboard

Toggle word wrap

6.1.5. 環境でのホストの検索
リンクのコピー

以下のクエリーは、production 環境内の全ホストを返します。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts?search=environment=production \
| python3 -m json.tool

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts?search=environment=production \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

API 応答

{
    ...
    "results": [
        {
            "environment_name": "production",
            "name": "satellite.example.com",
            ...
        }
    ],
    "search": "environment=production",
    ...
}

{
    ...
    "results": [
        {
            "environment_name": "production",
            "name": "satellite.example.com",
            ...
        }
    ],
    "search": "environment=production",
    ...
}

Copy to Clipboard

Toggle word wrap

6.1.6. 特定のファクト値を含むホストの検索
リンクのコピー

以下のクエリーでは、RHV Hypervisor というモデル名のホストがすべて返されます。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts?search=model=\"RHV+Hypervisor\" \
| python3 -m json.tool

$ curl \
--request GET \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts?search=model=\"RHV+Hypervisor\" \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

API 応答

{
    ...
    "results": [
        {
            "model_id": 1,
            "model_name": "RHV Hypervisor",
            "name": "satellite.example.com",
            ...
        }
    ],
    "search": "model=\"RHV Hypervisor\"",
    ...
}

{
    ...
    "results": [
        {
            "model_id": 1,
            "model_name": "RHV Hypervisor",
            "name": "satellite.example.com",
            ...
        }
    ],
    "search": "model=\"RHV Hypervisor\"",
    ...
}

Copy to Clipboard

Toggle word wrap

6.1.7. ホストの削除
リンクのコピー

この要求は、名前が host1.example.com のホストを削除します。

API 要求

curl \
--request DELETE \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts/host1.example.com \
| python3 -m json.tool

$ curl \
--request DELETE \
--user My_User_Name:My_Password \
https://satellite.example.com/api/v2/hosts/host1.example.com \
| python3 -m json.tool

Copy to Clipboard

Toggle word wrap

6.1.8. 全ホストのブートディスクイメージのダウンロード
リンクのコピー

以下の要求では、ホストの完全な起動ディスクイメージを ID を使用してダウンロードします。

API 要求

curl \
--request GET \
--user My_User_Name:My_Password \
--output My_Image.iso \
https://satellite.example.com/api/bootdisk/hosts/host_ID?full=true

$ curl \
--request GET \
--user My_User_Name:My_Password \
--output My_Image.iso \
https://satellite.example.com/api/bootdisk/hosts/host_ID?full=true

Copy to Clipboard

Toggle word wrap

第6章 API チートシート

6.1. ホストの使用方法
リンクのコピー

6.1.1. ホストのリスト表示
リンクのコピー

6.1.2. ホストの情報要求
リンクのコピー

6.1.3. ホストのファクト表示
リンクのコピー

6.1.4. パターンが一致するホストの検索
リンクのコピー

6.1.5. 環境でのホストの検索
リンクのコピー

6.1.6. 特定のファクト値を含むホストの検索
リンクのコピー

6.1.7. ホストの削除
リンクのコピー

6.1.8. 全ホストのブートディスクイメージのダウンロード
リンクのコピー

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

第6章 API チートシート

6.1. ホストの使用方法リンクのコピーリンクがクリップボードにコピーされました!

6.1.1. ホストのリスト表示リンクのコピーリンクがクリップボードにコピーされました!

6.1.2. ホストの情報要求リンクのコピーリンクがクリップボードにコピーされました!

6.1.3. ホストのファクト表示リンクのコピーリンクがクリップボードにコピーされました!

6.1.4. パターンが一致するホストの検索リンクのコピーリンクがクリップボードにコピーされました!

6.1.5. 環境でのホストの検索リンクのコピーリンクがクリップボードにコピーされました!

6.1.6. 特定のファクト値を含むホストの検索リンクのコピーリンクがクリップボードにコピーされました!

6.1.7. ホストの削除リンクのコピーリンクがクリップボードにコピーされました!

6.1.8. 全ホストのブートディスクイメージのダウンロードリンクのコピーリンクがクリップボードにコピーされました!

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

多様性を受け入れるオープンソースの強化

会社概要

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

6.1. ホストの使用方法
リンクのコピー

6.1.1. ホストのリスト表示
リンクのコピー

6.1.2. ホストの情報要求
リンクのコピー

6.1.3. ホストのファクト表示
リンクのコピー

6.1.4. パターンが一致するホストの検索
リンクのコピー

6.1.5. 環境でのホストの検索
リンクのコピー

6.1.6. 特定のファクト値を含むホストの検索
リンクのコピー

6.1.7. ホストの削除
リンクのコピー

6.1.8. 全ホストのブートディスクイメージのダウンロード
リンクのコピー