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]
任意

ソートされた結果を順序付ける方法 (例: ascending (昇順) の ASC)

Validations:

  • String

organization_id
任意

組織 ID

Validations:

  • number.

name
任意

フィルターに使用するホストコレクション名

Validations:

  • String

activation_key_id
任意

アクティベーションキー 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
必須

組織 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