GET /katello/api/host_collections/:id
ホストコレクションの表示

Params

Param Name Description
id
Required

ホストコレクションの ID

Validations:

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


GET /katello/api/host_collections
ホストコレクションを一覧表示

GET /katello/api/organizations/:organization_id/host_collections
組織内のホストコレクションを一覧表示

GET /katello/api/activation_keys/:activation_key_id/host_collections
アクティベーションキー内のホストコレクションを一覧表示

Params

Param Name Description
search
Optional

検索文字列

Validations:

  • String

page
Optional

1 から始まるページ番号

Validations:

  • number.

per_page
Optional

戻されるページごとの結果数

Validations:

  • number.

order
Optional

フィールドと順序のソート (例: 'name DESC')

Validations:

  • String

full_results
Optional

すべての結果を表示するかどうか

Validations:

  • boolean

sort
Optional

ハッシュバージョンの 'order' パラメーター

Validations:

  • Hash

sort[by]
Optional

結果をソートするフィールド

Validations:

  • String

sort[order]
Optional

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

Validations:

  • String

organization_id
Optional

組織 ID

Validations:

  • number.

name
Optional

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

Validations:

  • String

activation_key_id
Optional

アクティベーションキー ID

Validations:

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

host_id
Optional

ホスト ID で製品をフィルター

Validations:

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

available_for
Optional

指定済みオブジェクトに関連付けることができるホストコレクションのみを返す指定済みオブジェクトを解釈します。値 'host' がサポートされます。

Validations:

  • String


POST /katello/api/host_collections
ホストコレクションの作成

POST /katello/api/organizations/:organization_id/host_collections
ホストコレクションの作成

Params

Param Name Description
organization_id
Required

組織 ID

Validations:

  • number.

name
Required

ホストコレクション名

Validations:

  • String

description
Optional

Validations:

  • String

host_ids
Optional

ホストコレクションのホストに置き換わるホスト ID の一覧

Validations:

  • Must be an array of any type

max_hosts
Optional

ホストコレクションのホストの最大数

Validations:

  • Integer

unlimited_hosts
Optional

ホストコレクションに無制限のホストが設定された可能性があるかどうか

Validations:

  • boolean


PUT /katello/api/host_collections/:id
ホストコレクションの更新

Params

Param Name Description
id
Required

ホストコレクションの ID

Validations:

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

name
Optional

ホストコレクション名

Validations:

  • String

description
Optional

Validations:

  • String

host_ids
Optional

ホストコレクションのホストに置き換わるホスト ID の一覧

Validations:

  • Must be an array of any type

max_hosts
Optional

ホストコレクションのホストの最大数

Validations:

  • Integer

unlimited_hosts
Optional

ホストコレクションに無制限のホストが設定された可能性があるかどうか

Validations:

  • boolean


PUT /katello/api/host_collections/:id/add_hosts
ホストをホストコレクションに追加

Params

Param Name Description
id
Required

ホストコレクションの ID

Validations:

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

host_ids
Optional

ホスト ID の配列

Validations:

  • Must be an array of any type


PUT /katello/api/host_collections/:id/remove_hosts
ホストコレクションからホストを削除

Params

Param Name Description
id
Required

ホストコレクションの ID

Validations:

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

host_ids
Optional

ホスト ID の配列

Validations:

  • Must be an array of any type


DELETE /katello/api/host_collections/:id
ホストコレクションの破棄

Params

Param Name Description
id
Required

ホストコレクションの ID

Validations:

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


POST /katello/api/host_collections/:id/copy
ホストコレクションのコピー作成

Params

Param Name Description
id
Required

ホストコレクションの ID

Validations:

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

name
Required

新規ホストコレクションの名前

Validations:

  • String