GET /katello/api/host_collections/:id
顯示主機集項目

參數

參數名字 描述
id
必填

主機集的 ID

Validations:

  • number.


GET /katello/api/host_collections
列出主機集

GET /katello/api/organizations/:organization_id/host_collections
列出組織中的主機集

GET /katello/api/activation_keys/:activation_key_id/host_collections
列出啟動金鑰中的主機集

參數

參數名字 描述
search
選填

搜尋字串

Validations:

  • String

page
選填

頁數,從 1 開始

Validations:

  • number.

per_page
選填

每頁要傳回的結果數量

Validations:

  • number.

order
選填

排序欄位與次序,例如「name DESC」

Validations:

  • String

full_result
選填

是否顯示所有結果

Validations:

  • boolean

sort
選填

「order」參數的雜湊版本

Validations:

  • Hash

sort[by]
選填

用來排序結果的欄位

Validations:

  • String

sort[order]
選填

如何排序結果的順序(比方說 ASC 從下到上)

Validations:

  • String

organization_id
選填

組織識別子

Validations:

  • number.

name
選填

要篩選的主機集名稱,透過

Validations:

  • String

activation_key_id
選填

啟動金鑰的識別子

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..

host_id
選填

Filter products by host id

Validations:

  • number.

available_for
選填

Interpret specified object to return only Host Collections that can be associated with specified object. The value 'host' is supported.

Validations:

  • String


POST /katello/api/host_collections
建立主機集

POST /katello/api/organizations/:organization_id/host_collections
建立主機集

參數

參數名字 描述
organization_id
必填

組織識別子

Validations:

  • number.

name
必填

主機集名稱

Validations:

  • String

description
選填

Validations:

  • String

host_ids
選填

List of host ids to replace the hosts in host collection

Validations:

  • Must be an array of any type

max_hosts
選填

Maximum number of hosts in the host collection

Validations:

  • Integer

unlimited_hosts
選填

Whether or not the host collection may have unlimited hosts

Validations:

  • boolean


PUT /katello/api/host_collections/:id
更新主機集項目

參數

參數名字 描述
id
必填

主機集的 ID

Validations:

  • number.

name
選填

主機集名稱

Validations:

  • String

description
選填

Validations:

  • String

host_ids
選填

List of host ids to replace the hosts in host collection

Validations:

  • Must be an array of any type

max_hosts
選填

Maximum number of hosts in the host collection

Validations:

  • Integer

unlimited_hosts
選填

Whether or not the host collection may have unlimited hosts

Validations:

  • boolean


PUT /katello/api/host_collections/:id/add_hosts
Add host to the host collection

參數

參數名字 描述
id
必填

主機集的 ID

Validations:

  • number.

host_ids
選填

Array of host ids

Validations:

  • Must be an array of any type


PUT /katello/api/host_collections/:id/remove_hosts
Remove hosts from the host collection

參數

參數名字 描述
id
必填

主機集的 ID

Validations:

  • number.

host_ids
選填

Array of host ids

Validations:

  • Must be an array of any type


DELETE /katello/api/host_collections/:id
銷毀主機集

參數

參數名字 描述
id
必填

主機集的 ID

Validations:

  • number.


POST /katello/api/host_collections/:id/copy
複製一份主機集

參數

參數名字 描述
id
必填

主機集的 ID

Validations:

  • number.

name
必填

新的主機集項目名稱

Validations:

  • String