API 指南

1. 选择您要用作起点的现有生命周期环境。使用其 ID 列出环境，本例中为 ID 为 1 的环境：

   请求示例：

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

   Copy to Clipboard Toggle word wrap

   响应示例：

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

   Copy to Clipboard Toggle word wrap

2. 创建包含以下内容的 JSON 文件，如 life-cycle.json ：

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

   Copy to Clipboard Toggle word wrap

3. 使用之前选项设置为 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 \
   | python -m json.tool

   Copy to Clipboard Toggle word wrap

   响应示例：

         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

   Copy to Clipboard Toggle word wrap

   在命令输出中，您可以看到该生命周期环境的 ID 是 2，并且该生命周期环境前面是 1。使用 ID 为 2 的生命周期环境为此环境创建成功。

4. 编辑之前创建的 life-cycle.json 文件，更新 标签、name 和 before 值。

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

   Copy to Clipboard Toggle word wrap

5. 使用之前选项设置为 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 \
   | python -m json.tool

   Copy to Clipboard Toggle word wrap

   响应示例：

         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

   Copy to Clipboard Toggle word wrap

   在命令输出中，您可以看到此生命周期环境的 ID 是 3，在这前的生命周期环境是 2。

1. 创建上传请求。
2. 上传内容。
3. 导入内容。
4. 删除上传请求。

流程

1. 创建上传请求。确保修改示例参数以适合您的部署。

   请求示例：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request POST --insecure \
   --user sat_username:sat_password  --data "{}" \
   https://satellite.example.com/katello/api/repositories/3/content_uploads

   Copy to Clipboard Toggle word wrap

   此命令返回 upload_id。

   响应示例：

   {"upload_id":"0be156b1-f373-4cad-89d0-924f8f4491d2","_href":"/pulp/api/v2/content/uploads/0be156b1-f373-4cad-89d0-924f8f4491d2/"}

   Copy to Clipboard Toggle word wrap

   注意 upload_id 用于上传内容。

2. 上传内容。确保在上传数据时使用正确的 MIME 类型。API 将 application/json MIME 类型用于大多数对 Satellite 6 的请求。将 upload_id、MIME 类型和其他参数合并在一起，以上传内容。

   请求示例：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:multipart/form-data" \
   --request PUT --insecure --user sat_username:sat_password \
   --data-urlencode "content@/home/sat6user/rpmbuild/RPMS/noarch/python-scripttest-1.1.1-1.fc21.noarch.rpm" \
   --data-urlencode offset=0 \
   https://satellite.example.com/katello/api/repositories/3/content_uploads/0be156b1-f373-4cad-89d0-924f8f4491d2

   Copy to Clipboard Toggle word wrap

3. 将内容上传到卫星服务器后，您需要将其导入到相应的存储库。完成此步骤后，卫星服务器才会检测到新内容。

   请求示例：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request PUT --insecure \
   --user sat_username:sat_password \
   --data "{\"uploads\":[\"0be156b1-f373-4cad-89d0-924f8f4491d2\"]}" \
   https://satellite.example.com/katello/api/repositories/3/import_uploads

   Copy to Clipboard Toggle word wrap

4. 成功上传并导入您的内容后，您可以删除上传请求。这样可在上传过程中释放任何数据的临时磁盘空间。

   请求示例：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request DELETE --insecure \
   --user sat_username:sat_password --data "{}" \
   https://satellite.example.com/katello/api/repositories/3/content_uploads/0be156b1-f373-4cad-89d0-924f8f4491d2

   Copy to Clipboard Toggle word wrap

1. 使用以下示例将文件分成 2MB 块：

   $ split --bytes 2MB --numeric-suffixes --suffix-length=1 \
   theforeman-foreman-5.0.1.tar.gz foreman_module.

   Copy to Clipboard Toggle word wrap

2. 查看生成的文件：

   $ ls -la theforeman-foreman-5.0.1.tar.gz foreman_module.*
   -rw-r--r--. 1 root root 50000 Nov  4 04:42 foreman_module.0
   -rw-r--r--. 1 root root 32928 Nov  4 04:42 foreman_module.1
   -rw-r--r--. 1 root root 82928 Nov  4 04:41 theforeman-foreman-5.0.1.tar.gz

   Copy to Clipboard Toggle word wrap

3. 创建上传请求。

   请求示例：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request POST --insecure --user sat_username:sat_password --data "{}" \
   https://ibm-vm01.example.com/katello/api/repositories/2/content_uploads

   Copy to Clipboard Toggle word wrap

   响应示例：

   {"upload_id":"9585528f-07ad-4bb1-9c80-ccece249b2b7","_href":"/pulp/api/v2/content/uploads/9585528f-07ad-4bb1-9c80-ccece249b2b7/"}

   Copy to Clipboard Toggle word wrap

   注意 upload_id 用于上传内容。

4. 将文件块上传到卫星服务器。请注意，在这个示例中使用 offset 参数，以及如何与文件大小相关：

   请求示例：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:multipart/form-data" \
   --request PUT --insecure --user sat_username:sat_password \
   --data-urlencode "content@foreman_module.0" \
   --data-urlencode offset=0 \
   https://ibm-vm01.example.com/katello/api/repositories/2/content_uploads/9585528f-07ad-4bb1-9c80-ccece249b2b7

   Copy to Clipboard Toggle word wrap

5. 将完整上传导入到存储库：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request PUT --insecure --user sat_username:sat_password \
   --data "{\"upload_ids\":[\"9585528f-07ad-4bb1-9c80-ccece249b2b7\"]}" \
   https://ibm-vm01.example.com/katello/api/repositories/2/import_uploads

   Copy to Clipboard Toggle word wrap

6. 删除上传请求：

   $ curl --header "Accept:application/json" \
   --header "Content-Type:application/json" \
   --request DELETE --insecure --user sat_username:sat_password --data "{}" \
   https://ibm-vm01.example.com/katello/api/repositories/2/content_uploads/9585528f-07ad-4bb1-9c80-ccece249b2b7

   Copy to Clipboard Toggle word wrap

7. 在卫星服务器上，检查传输的文件：

   # ls -la /var/lib/pulp/content/puppet_module/theforeman-foreman-5.0.1.tar.gz
   -rw-r--r--. 1 apache apache 82928 Nov  4 04:55 /var/lib/pulp/content/puppet_module/theforeman-foreman-5.0.1.tar.gz

   Copy to Clipboard Toggle word wrap

8. 通过比较验证初始文件是否与传输相同：

   $ cmp /var/lib/pulp/content/puppet_module/theforeman-foreman-5.0.1.tar.gz \
   theforeman-foreman-5.0.1.tar.gz

   Copy to Clipboard Toggle word wrap

1. 在 Satellite Web UI 中，进入 Hosts > All Hosts，点 Search 字段来显示搜索参数列表。
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\" \
   | python -m json.tool

   Copy to Clipboard Toggle word wrap

   响应示例：

     {
       ...
       "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
   }

   Copy to Clipboard Toggle word wrap

1. 查找您要更改的 Smart Class 参数的 ID：

   • 列出所有智能类参数。

     请求示例：

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

     Copy to Clipboard Toggle word wrap

   • 如果您知道 Puppet 类 ID，例如 5，您可以限制范围：

     请求示例：

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

     Copy to Clipboard Toggle word wrap

     这两个调用都接受 search 参数。您可以在卫星 Web UI 中查看可搜索字段的完整列表。进入 Configure > Smart variables 并点 搜索查询框中显示字段列表。

     两个特别有用的搜索参数是 puppetclass_name 和 键，您可以使用它们搜索特定的参数。例如，使用 --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

     Copy to Clipboard Toggle word wrap

     卫星支持标准范围的搜索语法。

2. 当您找到 参数的 ID 时，列出包括当前覆盖值的完整详情。

   请求示例：

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

   Copy to Clipboard Toggle word wrap

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

   Copy to Clipboard Toggle word wrap

   请注意，您无法手动创建或删除参数。您只能修改它们的属性。卫星仅在从代理导入类时创建和删除参数。

4. 添加自定义覆盖匹配器。

   请求示例：

   $ 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

   Copy to Clipboard Toggle word wrap

   有关覆盖值的更多信息，请参阅 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

   Copy to Clipboard Toggle word wrap

1. 按照名称搜索 Puppet 类，本例中为 motd。

   请求示例：

   $ 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 \
   | python -m json.tool

   Copy to Clipboard Toggle word wrap

2. 检查以下输出：每个智能类参数都有具有相同 Satellite 实例的全局 ID。motd 类 的内容 参数在这一卫星服务器中具有 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": ""
   }

   Copy to Clipboard Toggle word wrap

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 \
   | python -m json.tool > output_file.json

   Copy to Clipboard Toggle word wrap

4. 将上一步中创建的文件复制到用于编辑的新文件中，例如 changed_file.json:

   $ cp output_file.json changed_file.json

   Copy to Clipboard Toggle word wrap

5. 修改文件所需的值。在本例中，将 motd 模块的内容参数更改为 true，这需要将 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": ""
   }

   Copy to Clipboard Toggle word wrap

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": ""
   }

   Copy to Clipboard Toggle word wrap

7. 将更改应用到 Satellite 服务器：

   $ 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

   Copy to Clipboard Toggle word wrap

1. 列出所有 OpenSCAP 报告。请注意您要删除的报告的 ID。

   请求示例：

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

   Copy to Clipboard Toggle word wrap

   响应示例：

     % 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

   Copy to Clipboard Toggle word wrap

2. 使用上一步中的 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

   Copy to Clipboard Toggle word wrap

   响应示例：

   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

   Copy to Clipboard Toggle word wrap