API ガイド

1. 開始点として使用する既存のライフサイクル環境を選択します。その ID を使用して環境を表示します。今回の例では、ID が 1 の環境を使用します。

   要求例:

   $ curl --request GET --user sat_username:sat_password --insecure \
   https://satellite.example.com/katello/api/environments/1 \
   | python3 -m json.tool

   応答例:

   	output omitted
      "id": 1,
      "label": "Library",
   	output omitted
       "prior": null,
       "successor": null,
     output truncated

2. 以下のコンテンツを含めて、life-cycle.json などの JSON ファイルを作成します。

   {"organization_id":1,"label":"api-dev","name":"API Development","prior":1}

3. prior オプションを 1 に設定して、ライフサイクル環境を作成します。

   要求例:

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request POST --user sat_username:sat_password --insecure \
   --data @life-cycle.json \
   https://satellite.example.com/katello/api/environments \
   | python3 -m json.tool

   応答例:

         output omitted
       "description": null,
       "id": 2,
       "label": "api-dev",
       "library": false,
       "name": "API Development",
       "organization": {
           "id": 1,
           "label": "Default_Organization",
           "name": "Default Organization"
       },
       "permissions": {
           "destroy_lifecycle_environments": true,
           "edit_lifecycle_environments": true,
           "promote_or_remove_content_views_to_environments": true,
           "view_lifecycle_environments": true
       },
      "prior": {
           "id": 1,
           "name": "Library"
       },
       output truncated

   以下のコマンドの出力では、ライフサイクル環境の ID が 2 で、その 1 つ前のライフサイクル環境は 1 であると分かります。ID が 2 のライフサイクル環境を使用して、この環境の後継を作成します。

4. 以前作成した life-cycle.json ファイルを編集して、label、name、prior の値を更新します。

   {"organization_id":1,"label":"api-qa","name":"API QA","prior":2}

5. prior オプションを 2 に設定して、ライフサイクル環境を作成します。

   要求例:

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request POST --user sat_username:sat_password --insecure \
   --data @life-cycle.json \
   https://satellite.example.com/katello/api/environments \
   | python3 -m json.tool

   応答例:

         output omitted
      "description": null,
      "id": 3,
       "label": "api-qa",
       "library": false,
       "name": "API QA",
       "organization": {
           "id": 1,
           "label": "Default_Organization",
           "name": "Default Organization"
       },
       "permissions": {
           "destroy_lifecycle_environments": true,
           "edit_lifecycle_environments": true,
           "promote_or_remove_content_views_to_environments": true,
           "view_lifecycle_environments": true
       },
      "prior": {
           "id": 2,
           "name": "API Development"
       },
       "successor": null,
       output truncated

   以下のコマンドの出力では、ライフサイクル環境の ID が 3 で、その 1 つ前のライフサイクル環境は 2 であると分かります。

1. アップロード要求を作成します。
2. コンテンツをアップロードします。
3. コンテンツをインポートします。
4. アップロード要求を削除します。

手順

1. パッケージ名を変数 名 に割り当てます。

   要求例:

   $ export name=jq-1.6-2.el7.x86_64.rpm

2. ファイルのチェックサムを変数 チェックサム に割り当てます。

   要求例:

   $ export checksum=$(sha256sum $name|cut -c 1-65)

3. ファイルサイズを変数 サイズ に割り当てます。

   要求例:

   $ export size=$(du -bs $name|cut -f 1)

4. 以下のコマンドは、新しいアップロード要求を作成し、サイズ と チェックサム を使用して要求のアップロード ID を返します。

   要求例:

   $ curl -H 'Content-Type: application/json' -X POST -k \
   -u sat_username:sat_password -d "{\"size\": \"$size\", \
   \"checksum\":\"$checksum\"}" \
   https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads

   今回の場合は、76 はリポジトリー ID の例です。

   要求例:

   {"upload_id":"37eb5900-597e-4ac3-9bc5-2250c302fdc4"}

5. 変数 upload_id にアップロード ID を割り当てます。

   要求例:

   $ export upload_id=37eb5900-597e-4ac3-9bc5-2250c302fdc4

6. アップロードするパッケージのパスを変数 パス に割り当てます。

   $ export path=/root/jq/jq-1.6-2.el7.x86_64.rpm

7. コンテンツをアップロードします。データのアップロード時には、正しい MIME タイプを使用していることを確認します。この API では、Satellite 6 に対する要求にほぼ、application/json の MIME タイプが使用します。upload_id と MIME タイプ、他のパラメーターを組み合わせてコンテンツをアップロードします。

   要求例:

   $ curl -u sat_username:sat_password -H Accept:application/json -H \
   Content-Type:multipart/form-data -X PUT --data-urlencode size=$size --data-urlencode offset=0 \
   --data-urlencode content@${path} \
   https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id

8. Satellite Server にコンテンツをアップロードした後に、適切なリポジトリーにそのコンテンツをインポートする必要があります。この手順を完了するまで、Satellite Server ではこの新しいコンテンツは認識されません。

   要求例:

   $ curl -H "Content-Type:application/json" -X PUT -u \
   sat_username:sat_password -k -d \
   "{\"uploads\":[{\"id\": \"$upload_id\", \"name\": \"$name\", \
   \"checksum\": \"$checksum\" }]}" \
   https://$(hostname -f)/katello/api/v2/repositories/76/import_uploads

9. コンテンツのアップロードおよびインポートが正常に完了したら、アップロード要求を削除することができます。削除することで、アップロード中にデータが使用した一時的なディスク領域を解放することができます。

   要求例:

   $ curl -H 'Content-Type: application/json' -X DELETE -k \
   -u sat_username:sat_password -d "{}" \
   https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id

1. パッケージ名を変数 名 に割り当てます。

   $ export name=bpftool-3.10.0-1160.2.1.el7.centos.plus.x86_64.rpm

2. ファイルのチェックサムを変数 チェックサム に割り当てます。

   $ export  checksum=$(sha256sum $name|cut -c 1-65)

3. ファイルサイズを変数 サイズ に割り当てます。

   $ export  size=$(du -bs $name|cut -f 1)

4. 以下のコマンドは、新しいアップロード要求を作成し、サイズ と チェックサム を使用して要求のアップロード ID を返します。

   要求例:

   $ curl -H 'Content-Type: application/json' -X POST -k \
   -u sat_username:sat_password -d "{\"size\": \"$size\", \
   \"checksum\":\"$checksum\"}" \
   https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads

   今回の場合は、76 はリポジトリー ID の例です。

   出力例

   {"upload_id":"37eb5900-597e-4ac3-9bc5-2250c302fdc4"}

5. 変数 upload_id にアップロード ID を割り当てます。

   $ export upload_id=37eb5900-597e-4ac3-9bc5-2250c302fdc4

6. ファイルを 2MB のチャンクに分割します。

   $ split --bytes 2MB --numeric-suffixes \
   --suffix-length=1 bpftool-3.10.0-1160.2.1.el7.centos.plus.x86_64.rpm bpftool

   出力例

   $ ls bpftool[0-9] -l
   -rw-r--r--. 1 root root 2000000 Mar 31 14:15 bpftool0
   -rw-r--r--. 1 root root 2000000 Mar 31 14:15 bpftool1
   -rw-r--r--. 1 root root 2000000 Mar 31 14:15 bpftool2
   -rw-r--r--. 1 root root 2000000 Mar 31 14:15 bpftool3
   -rw-r--r--. 1 root root  868648 Mar 31 14:15 bpftool4

7. 分割ファイルの接頭辞を変数パスに割り当てます。

   $ export path=/root/tmp/bpftool

8. ファイルのチャンクをアップロードします。オフセットは、最初のチャンクの 0 から始まり、ファイルごとに 2000000 ずつ増加します。offset パラメーターを使用して、ファイルサイズと関連付けている点に注意してください。また、インデックスはパス変数の後に使用されます (例: ${path}0、${path}1)。

   要求例:

   $ curl -u sat_username:sat_password -H Accept:application/json -H \
   Content-Type:multipart/form-data  \
   -X PUT --data-urlencode size=$size --data-urlencode offset=0 \
   --data-urlencode content@${path}0 https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id
   
   $ curl -u sat_username:sat_password -H Accept:application/json -H \
   Content-Type:multipart/form-data \
   -X PUT --data-urlencode size=$size --data-urlencode offset=2000000 \
   --data-urlencode content@${path}1 https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id
   
   $ curl -u sat_username:sat_password -H Accept:application/json -H \
   Content-Type:multipart/form-data \
   -X PUT --data-urlencode size=$size --data-urlencode offset=4000000 \
   --data-urlencode content@${path}2 https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id
   
   $curl -u sat_username:sat_password -H Accept:application/json -H \
   Content-Type:multipart/form-data \
   -X PUT --data-urlencode size=$size --data-urlencode offset=6000000
   --data-urlencode content@${path}3 https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id
   
   $ curl -u sat_username:sat_password -H Accept:application/json -H \
   Content-Type:multipart/form-data \
   -X PUT --data-urlencode size=$size --data-urlencode offset=8000000 \
   --data-urlencode content@${path}4 https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id

9. 完全なアップロードをリポジトリーにインポートします。

   $ curl -H "Content-Type:application/json" -X PUT -u \
   sat_username:sat_password -k -d \
   "{\"uploads\":[{\"id\": \"$upload_id\", \
   \"name\": \"$name\", \"checksum\": \"$checksum\" }]}" \
   https://$(hostname -f)/katello/api/v2/repositories/76/import_uploads

10. アップロード要求を削除します。

    $ curl -H 'Content-Type: application/json' -X DELETE -k \
    -u sat_username:sat_password -d "{}" \
    https://$(hostname -f)/katello/api/v2/repositories/76/content_uploads/$upload_id

1. Satellite Web UI で、ホスト > すべてのホスト に移動して、検索 フィールドをクリックして、検索パラメーターのリストを表示します。
2. 使用する検索パラメーターの場所を特定します。以下の例では、os_title と model を特定します。

3. 以下のように、API クエリーで検索パラメーターを組み合わせます。

   要求例:

   $ curl --insecure --user sat_username:sat_password \
   https://satellite.example.com/api/v2/hosts?search=os_title=\"RedHat+7.7\",model=\"PowerEdge+R330\" \
   | python3 -m json.tool

   注記

   この要求例では、python3 を使用して Satellite Server からの応答をフォーマットしています。RHEL 7 およびそれ以前の一部のシステムでは、python3 の代わりに python を使用する必要があります。

   応答例:

     {
       ...
       "results": [
           {
               "model_id": 1,
               "model_name": "PowerEdge R330",
               "name": "satellite.example.com",
               "operatingsystem_id": 1,
               "operatingsystem_name": "RedHat 7.7",
               ...
           }
       ],
       "search": "os_title=\"RedHat 7.7\",model=\"PowerEdge R330\"",
       "subtotal": 1,
       "total": 11
   }

1. 変更するスマートクラスパラメーターの ID を検索します。

   • スマートクラスパラメーターすべてを表示します。

     要求例:

     $ curl --request GET --insecure --user sat_username:sat_password \
     https://satellite.example.com/api/smart_class_parameters

   • 5 など、Puppet クラス ID が分かる場合には、範囲を絞り込むことができます。

     要求例:

     $ curl --request GET --insecure --user sat_username:sat_password \
     https://satellite.example.com/api/puppetclasses/5/smart_class_parameters

     どちらの呼び出しも検索パラメーターに対応します。Satellite Web UI で検索可能なフィールドの全リストを表示できます。設定 > スマート変数 に移動して、検索クエリーボックスをクリックし、フィールドのリストを表示します。

     特に検索パラメーターで便利なのは、puppetclass_name と key の 2 つで、特定のパラメーターの検索が可能になります。たとえば、--data オプションを使用して URL のエンコードデータを渡すことができます。

     要求例:

     $ curl --request GET --insecure --user sat_username:sat_password \
     --data 'search=puppetclass_name = access_insights_client and key = authmethod' \
     https://satellite.example.com/api/smart_class_parameters

     Satellite は、標準のスコープ指定の検索構文をサポートします。

2. パラメーターの ID が見つかると、現在の上書き値など、全詳細が表示されます。

   要求例:

   $ curl --request GET --insecure --user sat_username:sat_password \
   https://satellite.example.com/api/smart_class_parameters/63

3. パラメーターの値のオーバーライドを有効化します。

   要求例:

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request PUT --insecure --user sat_username:sat_password \
   --data '{"smart_class_parameter":{"override":true}}' \
   https://satellite.example.com/api/smart_class_parameters/63

   パラメーターを手動で作成または削除できない点に注意してください。属性の変更のみが可能です。Satellite は、パラメーターは、プロキシーからクラスをインポートすることでのみ作成、削除されます。

4. カスタムの override matcher を追加します。

   要求例:

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request PUT --insecure --user sat_username:sat_password \
   --data '{"smart_class_parameter":{"override_value":{"match":"hostgroup=Test","value":"2.4.6"}}}' \
   https://satellite.example.com/api/smart_class_parameters/63

   オーバーライドの値に関する情報は、https://satellite.example.com/apidoc/v2/override_values.html を参照してください。

5. 上書きの値を削除します。

   要求例:

   $ curl --request DELETE --user sat_username:sat_password \
   https://satellite.example.com/api/smart_class_parameters/63/override_values/3

1. 今回の例では、motd という名前で Puppet クラスを検索します。

   要求例:

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request GET --user sat_user:sat_password --insecure \
   https://satellite.example.com/api/smart_class_parameters?search=puppetclass_name=motd \
   | python3 -m json.tool

2. 以下の出力を検証します。スマートクラスのパラメーターにはそれぞれ、同じ Satellite インスタンスでグローバルとなる ID が割り当てられています。Satellite Server では、motd クラスの content パラメーターは id=3 となっています。Puppet クラス名の前に表示される Puppet クラス ID と混同しないようにしてください。

   応答例:

   {
   	"avoid_duplicates": false,
   		"created_at": "2017-02-06 12:37:48 UTC", # Remove this line.
   			"default_value": "", # Add a new value here.
   			"description": "",
   		"hidden_value": "",
   		"hidden_value?": false,
   		"id": 3,
   		"merge_default": false,
   		"merge_overrides": false,
   		"override": false, # Set the override value to true.
   			"override_value_order": "fqdn\nhostgroup\nos\ndomain",
   		"override_values": [], # Remove this line.
   			"override_values_count": 0,
   		"parameter": "content",
   		"parameter_type": "string",
   		"puppetclass_id": 3,
   		"puppetclass_name": "motd",
   		"required": false,
   		"updated_at": "2017-02-07 11:56:55 UTC", # Remove this line.
   			"use_puppet_default": false,
   		"validator_rule": null,
   		"validator_type": ""
   }

3. パラメーター ID 3 を使用して、motd パラメーター固有の情報を取得して、出力を output_file.json などのファイルにリダイレクトします。

   要求例:

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" --request GET \
   --user sat_user:sat_password --insecure \`
   https://satellite.example.com/api/smart_class_parameters/3 \
   | python3 -m json.tool > output_file.json

4. 1 つ前の手順で作成したファイルを、新しいファイル (例: changed_file.json) にコピーして編集します。

   $ cp output_file.json changed_file.json

5. ファイルで、必要な値を変更します。以下の例では、motd モジュールのコンテンツパラメーターを変更しますが、これには、override オプションを false から true に変更する必要があります。

   {
   	"avoid_duplicates": false,
   		"created_at": "2017-02-06 12:37:48 UTC", # Remove this line.
   			"default_value": "", # Add a new value here.
   			"description": "",
   		"hidden_value": "",
   		"hidden_value?": false,
   		"id": 3,
   		"merge_default": false,
   		"merge_overrides": false,
   		"override": false, # Set the override value to true.
   			"override_value_order": "fqdn\nhostgroup\nos\ndomain",
   		"override_values": [], # Remove this line.
   			"override_values_count": 0,
   		"parameter": "content",
   		"parameter_type": "string",
   		"puppetclass_id": 3,
   		"puppetclass_name": "motd",
   		"required": false,
   		"updated_at": "2017-02-07 11:56:55 UTC", # Remove this line.
   			"use_puppet_default": false,
   		"validator_rule": null,
   		"validator_type": ""
   }

6. ファイルの編集後に、以下のようになっていることを確認して、変更を保存します。

   {
   	"avoid_duplicates": false,
   		"default_value": "No Unauthorized Access Allowed",
   			"description": "",
   		"hidden_value": "",
   		"hidden_value?": false,
   		"id": 3,
   		"merge_default": false,
   		"merge_overrides": false,
   		"override": true,
   			"override_value_order": "fqdn\nhostgroup\nos\ndomain",
   		"override_values_count": 0,
   		"parameter": "content",
   		"parameter_type": "string",
   		"puppetclass_id": 3,
   		"puppetclass_name": "motd",
   		"required": false,
   		"use_puppet_default": false,
   		"validator_rule": null,
   		"validator_type": ""
   }

7. Satellite Server への変更を適用します。

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request PUT --user sat_username:sat_password --insecure \
   --data @changed_file.json \
   https://satellite.example.com/api/smart_class_parameters/3

1. 全 OpenSCAP レポートを表示します。削除するレポートの ID をメモしてください。

   要求例:

   curl --insecure --user username:_password_ \
   https://satellite.example.com/api/v2/compliance/arf_reports/ | python3 -m json.tool

   応答例:

     % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                    Dload  Upload   Total   Spent    Left  Speed
   100  3252    0  3252    0     0   4319      0 --:--:-- --:--:-- --:--:--  4318
   {
       "page": 1,
       "per_page": 20,
       "results": [
           {
               "created_at": "2017-05-16 13:27:09 UTC",
               "failed": 0,
               "host": "host1.example.com",
               "id": 404,
               "othered": 0,
               "passed": 0,
               "updated_at": "2017-05-16 13:27:09 UTC"
           },
           {
               "created_at": "2017-05-16 13:26:07 UTC",
               "failed": 0,
               "host": "host2.example.com,
               "id": 405,
               "othered": 0,
               "passed": 0,
               "updated_at": "2017-05-16 13:26:07 UTC"
           },
           {
               "created_at": "2017-05-16 13:25:07 UTC",
               "failed": 0,
               "host": "host3.example.com",
               "id": 406,
               "othered": 0,
               "passed": 0,
               "updated_at": "2017-05-16 13:25:07 UTC"
           },
           {
               "created_at": "2017-05-16 13:24:07 UTC",
               "failed": 0,
               "host": "host4.example.com",
               "id": 407,
               "othered": 0,
               "passed": 0,
               "updated_at": "2017-05-16 13:24:07 UTC"
           },
       ],
       "search": null,
       "sort": {
           "by": null,
           "order": null
       },
       "subtotal": 29,
       "total": 29

2. 1 つ前の手順で取得した ID を使用して、OpenSCAP レポートを削除します。削除する ID ごとに同様の手順を繰り返します。

   要求例:

   # curl --insecure --user username:_password_ \
   --header "Content-Type: application/json" \
   --request DELETE https://satellite.example.com/api/v2/compliance/arf_reports/405

   応答例:

   HTTP/1.1 200 OK
   Date: Thu, 18 May 2017 07:14:36 GMT
   Server: Apache/2.4.6 (Red Hat Enterprise Linux)
   X-Frame-Options: SAMEORIGIN
   X-XSS-Protection: 1; mode=block
   X-Content-Type-Options: nosniff
   Foreman_version: 1.11.0.76
   Foreman_api_version: 2
   Apipie-Checksum: 2d39dc59aed19120d2359f7515e10d76
   Cache-Control: max-age=0, private, must-revalidate
   X-Request-Id: f47eb877-35c7-41fe-b866-34274b56c506
   X-Runtime: 0.661831
   X-Powered-By: Phusion Passenger 4.0.18
   Set-Cookie: request_method=DELETE; path=/
   Set-Cookie: _session_id=d58fe2649e6788b87f46eabf8a461edd; path=/; secure; HttpOnly
   ETag: "2574955fc0afc47cb5394ce95553f428"
   Status: 200 OK
   Vary: Accept-Encoding
   Transfer-Encoding: chunked
   Content-Type: application/json; charset=utf-8