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. 创建一个 JSON 文件，如 life-cycle.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。使用 ID 为 2 的生命周期环境，为这个环境创建一个成功。

4. 编辑之前创建的 生命周期.json 文件，更新 标签、名称 和 之前 的值。

   {"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，且该生命周期环境是 2。

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

流程

1. 将软件包名称分配给 变量名称 ：

   请求示例：

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

2. 将文件的 checksum 分配给变量 checksum ：

   请求示例：

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

3. 将文件大小分配给变量 大小 ：

   请求示例：

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

4. 以下命令创建一个新的上传请求，并使用 大小 和 checksum 返回请求的上传 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. 将上传 ID 分配给变量 upload_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 使用 application/json MIME 类型，大多数请求都对 Satellite 6 使用。组合 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. 将内容上传到卫星服务器后，您需要将其导入到适当的存储库。在完成此步骤前，卫星服务器不会检测到新内容。

   请求示例：

   $ 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. 将文件的 checksum 分配给变量 checksum ：

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

3. 将文件大小分配给变量 大小 ：

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

4. 以下命令创建一个新的上传请求，并使用 大小 和 checksum 返回请求的上传 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. 将上传 ID 分配给变量 upload_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。注意使用偏移参数以及如何与文件大小相关。另请注意，索引在 path 变量后使用，如 ${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 中，导航到 Hosts > All Hosts，然后点击 Search 字段来显示搜索参数列表。
2. 找到您要使用的搜索参数。在本例中，找到 os_title 和 模型。

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 服务器中的 respone。在 RHEL 7 和一些较旧的系统中，您必须使用 python 而不是 python3。

   响应示例：

     {
       ...
       "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. 查找您要更改的 Smart Class 参数的 ID：

   • 列出所有智能类参数。

     请求示例：

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

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

     请求示例：

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

     这两个调用都接受 search 参数。您可以在 Satellite Web UI 中查看可搜索字段的完整列表。导航到 Configure > Smart variables，然后在搜索查询框中点击以显示字段列表。

     两个特别有用的搜索参数是 puppetclass_name 和 key，可用于搜索特定参数。例如，使用 --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. 添加自定义覆盖匹配器。

   请求示例：

   $ 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. 按名称搜索 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 \
   | python3 -m json.tool

2. 检查以下输出：每个智能类参数都有一个 ID，对于同一 Satellite 实例来说是全局的。motd 类 的内容 参数在这一卫星服务器中具有 id=3。不要将此与 Puppet Class 名称前面显示的 Puppet Class 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. 将上一步中创建的文件复制到要编辑的新文件，例如 changed_file.json ：

   $ cp output_file.json changed_file.json

5. 修改文件中所需的值。在本例中，将 motd 模块的 content 参数更改，这需要将 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 服务器：

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