GET /api/hosts
すべてのホストを一覧表示

GET /api/hostgroups/:hostgroup_id/hosts
ホストグループのすべてのホストを一覧表示

GET /api/locations/:location_id/hosts
ロケーションごとにホストを一覧表示

GET /api/organizations/:organization_id/hosts
組織ごとにホストを一覧表示

GET /api/environments/:environment_id/hosts
環境ごとにホストを一覧表示

パラメーター

パラメーター名 記述
thin
任意

ホストの一覧 ID および名前のみ

Validations:

  • Must be one of: true, false, 1, 0.

hostgroup_id
任意

ホストグループの ID

Validations:

  • String

location_id
任意

ロケーションの ID

Validations:

  • String

organization_id
任意

組織の ID

Validations:

  • String

environment_id
任意

環境の ID

Validations:

  • String

include
任意

含める追加の情報タイプの配列

Validations:

  • Must be one of: parameters, all_parameters.

search
任意

結果のフィルター

Validations:

  • String

order
任意

Sort field and order, eg. ‘id DESC’

Validations:

  • String

page
任意

結果のページネーション

Validations:

  • String

per_page
任意

要求ごとのエントリー数

Validations:

  • String

検索フィールド

フィールド名 タイプ 設定可能な値
activation_key string
activation_key_id string
addon text
addons_status valid, invalid
applicable_errata string
applicable_rpms string
architecture string
autoheal boolean
build true, false
class string
comment text
compute_resource string
compute_resource_id integer
config_group string
content_source string
content_view string
content_view_id integer
domain string
domain_id integer
environment string
errata_status security_needed, errata_needed, updated, unknown
facts string
global_status ok, warning, error
has_ip string
has_mac string
host_collection string
host_collection_id integer
hostgroup string
hostgroup_fullname string
hostgroup_id integer
hostgroup_name string
hostgroup_title string
hypervisor boolean
hypervisor_host string
image string
installable_errata string
installed_at datetime
installed_package string
installed_package_name string
ip string
last_checkin datetime
last_report datetime
lifecycle_environment string
lifecycle_environment_id integer
location string
location_id integer
mac string
managed true, false
model string
name string
organization string
organization_id integer
origin string
os string
os_description string
os_id integer
os_major string
os_minor string
os_title string
owner string
owner_id integer
owner_type string
params string
parent_hostgroup string
puppet_ca string
puppet_proxy_id integer
puppetmaster string
purpose_status valid, invalid
realm string
realm_id integer
registered_at datetime
registered_through string
release_version string
role text
role_status valid, invalid
service_level string
sla_status valid, invalid
smart_proxy string
status.applied integer
status.enabled true, false
status.failed integer
status.failed_restarts integer
status.interesting true, false
status.pending integer
status.restarted integer
status.skipped integer
subnet string
subnet.name text
subnet6 string
subnet6.name text
subscription_id string
subscription_name string
subscription_status valid, partial, invalid, unknown, unsubscribed_hypervisor
subscription_uuid string
trace_app string
trace_app_type string
trace_helper string
trace_status reboot_needed, process_restart_needed, updated
upgradable_rpms string
usage text
usage_status valid, invalid
user.firstname string
user.lastname string
user.login string
user.mail string
usergroup string
usergroup.name string
uuid string

GET /api/hosts/:id
ホストの表示

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

show_hidden_parameters
任意

非表示のパラメーター値の表示

Validations:

  • Must be one of: true, false, 1, 0.


POST /api/hosts
ホストの作成

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

host
必須

Validations:

  • Hash

host[name]
必須

Validations:

  • String

host[location_id]
必須

ロケーションが有効にされている場合に必須です。

Validations:

  • Must be a number.

host[organization_id]
必須

組織が有効にされている場合に必須です。

Validations:

  • Must be a number.

host[environment_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • String

host[ip]
任意 , nil可

DHCP プロキシーを使用するサブネットを使用する場合は不要です

Validations:

  • String

host[mac]
任意 , nil可

管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。

Validations:

  • String

host[architecture_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[domain_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[realm_id]
任意 , nil可

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

host[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type

host[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • String

host[medium_id]
任意 , nil可

イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • String

host[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
任意 , nil可

ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。

Validations:

  • Must be a number.

host[subnet_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[compute_resource_id]
任意 , nil可

Nil はホストがベアメタルであることを意味します

Validations:

  • Must be a number.

host[root_pass]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。

Validations:

  • String

host[model_id]
任意 , nil可

Validations:

  • Must be a number.

host[hostgroup_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_type]
任意 , nil可

ホストの所有者タイプ

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
任意 , nil可

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意 , nil可

ホストのパラメーター (配列またはインデックス化されたハッシュ)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
必須

パラメーター名

Validations:

  • String

host[host_parameters_attributes][value]
必須

パラメーター値

Validations:

  • String

host[build]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

host[enabled]
任意 , nil可

このホストを Foreman レポート内に組み込む

Validations:

  • Must be one of: true, false, 1, 0.

host[provision_method]
任意 , nil可

このメソッドは、ホストのプロビジョニングに使用されます。

Validations:

  • Must be one of: build, image.

host[managed]
任意 , nil可

ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。

Validations:

  • Must be one of: true, false, 1, 0.

host[progress_report_id]
任意 , nil可

オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks

Validations:

  • String

host[comment]
任意 , nil可

このホストについての追加情報

Validations:

  • String

host[capabilities]
任意 , nil可

Validations:

  • String

host[compute_profile_id]
任意 , nil可

Validations:

  • Must be a number.

host[interfaces_attributes]
任意 , nil可

ホストのネットワークインターフェース

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
任意 , nil可

インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。

Validations:

  • String

host[interfaces_attributes][ip]
任意 , nil可

インターフェースの IPv4 アドレス

Validations:

  • String

host[interfaces_attributes][ip6]
任意 , nil可

インターフェースの IPv6 アドレス

Validations:

  • String

host[interfaces_attributes][type]
任意 , nil可

インターフェースタイプ (bmc など)。デフォルト値は interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
任意 , nil可

インターフェースの DNS 名

Validations:

  • String

host[interfaces_attributes][subnet_id]
任意 , nil可

IPv4 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
任意 , nil可

IPv6 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
任意 , nil可

インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
任意 , nil可

デバイス ID。例: eth0 または eth1.1

Validations:

  • String

host[interfaces_attributes][managed]
任意 , nil可

このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか?

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][primary]
任意 , nil可

このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][provision]
任意 , nil可

このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][username]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • String

host[interfaces_attributes][password]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • String

host[interfaces_attributes][provider]
任意 , nil可

インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
任意 , nil可

エイリアスまたは VLAN デバイス

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][tag]
任意 , nil可

VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。

Validations:

  • String

host[interfaces_attributes][mtu]
任意 , nil可

MTU。この属性はサブネット MTU より優先されます。

Validations:

  • Integer

host[interfaces_attributes][attached_to]
任意 , nil可

このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。

Validations:

  • String

host[interfaces_attributes][mode]
任意 , nil可

インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
任意 , nil可

接続されたインターフェースの ID `['eth1', 'eth2']`。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
任意 , nil可

スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。

Validations:

  • String

host[interfaces_attributes][compute_attributes]
任意 , nil可

インターフェースの追加のコンピュートリソース固有の属性。

Validations:

  • Hash

host[compute_attributes]
任意 , nil可

追加のコンピュートリソース固有の属性。

Validations:

  • Hash

host[content_facet_attributes]
任意 , nil可

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
任意 , nil可

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
任意 , nil可

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
任意 , nil可

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
任意 , nil可

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
任意 , nil可

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
任意 , nil可

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
任意 , nil可

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • Must be one of: true, false, 1, 0.

host[subscription_facet_attributes][purpose_usage]
任意 , nil可

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_role]
任意 , nil可

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_addons]
任意 , nil可

Sets the system add-ons

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][service_level]
任意 , nil可

Service level to be used for autoheal

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
任意 , nil可

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
任意 , nil可

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
任意 , nil可

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
任意 , nil可

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
任意 , nil可

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
任意 , nil可

Product version

Validations:

  • String


PUT /api/hosts/:id
ホストの更新

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

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

host
必須

Validations:

  • Hash

host[name]
任意

Validations:

  • String

host[location_id]
任意

ロケーションが有効にされている場合に必須です。

Validations:

  • Must be a number.

host[organization_id]
任意

組織が有効にされている場合に必須です。

Validations:

  • Must be a number.

host[environment_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • String

host[ip]
任意 , nil可

DHCP プロキシーを使用するサブネットを使用する場合は不要です

Validations:

  • String

host[mac]
任意 , nil可

管理ホストがベアメタルの場合に必須です。仮想マシンの場合は不要です。

Validations:

  • String

host[architecture_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[domain_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[realm_id]
任意 , nil可

Validations:

  • Must be a number.

host[puppet_proxy_id]
任意 , nil可

Puppet プロキシー ID

Validations:

  • Must be a number.

host[puppet_ca_proxy_id]
任意 , nil可

Puppet CA プロキシー ID

Validations:

  • Must be a number.

host[puppetclass_ids]
任意 , nil可

Validations:

  • Must be an array of any type

host[config_group_ids]
任意 , nil可

関連付けられた設定グループの ID

Validations:

  • Must be an array of any type

host[operatingsystem_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • String

host[medium_id]
任意 , nil可

イメージベースのプロビジョニングでない場合で、ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • String

host[pxe_loader]
任意 , nil可

DHCP ファイル名オプション (デフォルトでは Grub2/PXELinux)

Validations:

  • Must be one of: None, PXELinux BIOS, PXELinux UEFI, Grub UEFI, Grub2 UEFI, Grub2 UEFI SecureBoot, Grub2 UEFI HTTP, Grub2 UEFI HTTPS, Grub2 UEFI HTTPS SecureBoot, iPXE Embedded, iPXE UEFI HTTP, iPXE Chain BIOS, iPXE Chain UEFI.

host[ptable_id]
任意 , nil可

ホストが管理されており、カスタムパーティションが定義されていない場合に必須です。

Validations:

  • Must be a number.

host[subnet_id]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていない場合に必須です。

Validations:

  • Must be a number.

host[compute_resource_id]
任意 , nil可

Nil はホストがベアメタルであることを意味します

Validations:

  • Must be a number.

host[root_pass]
任意 , nil可

ホストが管理されており、値がホストグループから継承されていないか、または設定済みのデフォルトパスワードである場合に必須です。

Validations:

  • String

host[model_id]
任意 , nil可

Validations:

  • Must be a number.

host[hostgroup_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_id]
任意 , nil可

Validations:

  • Must be a number.

host[owner_type]
任意 , nil可

ホストの所有者タイプ

Validations:

  • Must be one of: User, Usergroup.

host[image_id]
任意 , nil可

Validations:

  • Must be a number.

host[host_parameters_attributes]
任意 , nil可

ホストのパラメーター (配列またはインデックス化されたハッシュ)

Validations:

  • Must be an Array of nested elements

host[host_parameters_attributes][name]
任意

パラメーター名

Validations:

  • String

host[host_parameters_attributes][value]
任意

パラメーター値

Validations:

  • String

host[build]
任意 , nil可

Validations:

  • Must be one of: true, false, 1, 0.

host[enabled]
任意 , nil可

このホストを Foreman レポート内に組み込む

Validations:

  • Must be one of: true, false, 1, 0.

host[provision_method]
任意 , nil可

このメソッドは、ホストのプロビジョニングに使用されます。

Validations:

  • Must be one of: build, image.

host[managed]
任意 , nil可

ホストを管理対象とするかどうかについての True/False フラグです。注意: この値は複数のパラメーターが必要となるかどうかも決定します。

Validations:

  • Must be one of: true, false, 1, 0.

host[progress_report_id]
任意 , nil可

オーケストレーションタスクの状態を追跡するための UUID。GET /api/orchestration/:UUID/tasks

Validations:

  • String

host[comment]
任意 , nil可

このホストについての追加情報

Validations:

  • String

host[capabilities]
任意 , nil可

Validations:

  • String

host[compute_profile_id]
任意 , nil可

Validations:

  • Must be a number.

host[interfaces_attributes]
任意 , nil可

ホストのネットワークインターフェース

Validations:

  • Must be an Array of nested elements

host[interfaces_attributes][mac]
任意 , nil可

インターフェースの MAC アドレス。ベアメタルの管理対象インターフェースに必要です。

Validations:

  • String

host[interfaces_attributes][ip]
任意 , nil可

インターフェースの IPv4 アドレス

Validations:

  • String

host[interfaces_attributes][ip6]
任意 , nil可

インターフェースの IPv6 アドレス

Validations:

  • String

host[interfaces_attributes][type]
任意 , nil可

インターフェースタイプ (bmc など)。デフォルト値は interface

Validations:

  • Must be one of: interface, bmc, bond, bridge.

host[interfaces_attributes][name]
任意 , nil可

インターフェースの DNS 名

Validations:

  • String

host[interfaces_attributes][subnet_id]
任意 , nil可

IPv4 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][subnet6_id]
任意 , nil可

IPv6 インターフェースの Foreman サブネット ID

Validations:

  • Must be a number.

host[interfaces_attributes][domain_id]
任意 , nil可

インターフェースの Foreman ドメイン ID。管理対象ホストのプライマリーインターフェースに必要

Validations:

  • Must be a number.

host[interfaces_attributes][identifier]
任意 , nil可

デバイス ID。例: eth0 または eth1.1

Validations:

  • String

host[interfaces_attributes][managed]
任意 , nil可

このインターフェースは DHCP および DNS スマートプロキシーで管理し、プロビジョニング時に設定される必要がありますか?

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][primary]
任意 , nil可

このインターフェースをホストの FQDN の構築に使用する必要がありますか? 各管理対象ホストには 1 つのプライマリーインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][provision]
任意 , nil可

このインターフェースを PXELinux の TFTP に使用する必要がありますか (イメージベースのホストの場合は SSH)? 各管理対象ホストには 1 つのプロビジョンインターフェースがある必要があります。

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][username]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • String

host[interfaces_attributes][password]
任意 , nil可

BMC インターフェスのみ。

Validations:

  • String

host[interfaces_attributes][provider]
任意 , nil可

インターフェースプロバイダー (例: IPMI)。BMC インターフェースの場合にのみ使用できます。

Validations:

  • Must be one of: IPMI, SSH.

host[interfaces_attributes][virtual]
任意 , nil可

エイリアスまたは VLAN デバイス

Validations:

  • Must be one of: true, false, 1, 0.

host[interfaces_attributes][tag]
任意 , nil可

VLAN タグ。この属性はサブネット VLAN ID より優先されます。仮想インターフェースの場合のみ使用されます。

Validations:

  • String

host[interfaces_attributes][mtu]
任意 , nil可

MTU。この属性はサブネット MTU より優先されます。

Validations:

  • Integer

host[interfaces_attributes][attached_to]
任意 , nil可

このインターフェースが属するインターフェースの ID (例: eth1)。仮想インターフェースの場合にのみ使用できます。

Validations:

  • String

host[interfaces_attributes][mode]
任意 , nil可

インターフェースのボンドモードです (例: balance-rr)。ボンドインターフェースにのみ使用されます。

Validations:

  • Must be one of: balance-rr, active-backup, balance-xor, broadcast, 802.3ad, balance-tlb, balance-alb.

host[interfaces_attributes][attached_devices]
任意 , nil可

接続されたインターフェースの ID `['eth1', 'eth2']`。ボンドインターフェースの場合、これらはスレーブになります (ボンドおよびブリッジインターフェースの場合のみ)。

Validations:

  • Must be an array of any type

host[interfaces_attributes][bond_options]
任意 , nil可

スペースで区切られたオプション (例: e.g. miimon=100)。ボンドインターフェースの場合のみ使用します。

Validations:

  • String

host[interfaces_attributes][compute_attributes]
任意 , nil可

インターフェースの追加のコンピュートリソース固有の属性。

Validations:

  • Hash

host[compute_attributes]
任意 , nil可

追加のコンピュートリソース固有の属性。

Validations:

  • Hash

host[content_facet_attributes]
任意 , nil可

Parameters for host's content_facet facet

Validations:

  • Hash

host[content_facet_attributes][content_view_id]
任意 , nil可

Validations:

  • Integer

host[content_facet_attributes][lifecycle_environment_id]
任意 , nil可

Validations:

  • Integer

host[content_facet_attributes][content_source_id]
任意 , nil可

Validations:

  • Integer

host[content_facet_attributes][kickstart_repository_id]
任意 , nil可

Repository Id associated with the kickstart repo used for provisioning

Validations:

  • Integer

host[subscription_facet_attributes]
任意 , nil可

Parameters for host's subscription_facet facet

Validations:

  • Hash

host[subscription_facet_attributes][release_version]
任意 , nil可

Release version for this Host to use (7Server, 7.1, etc)

Validations:

  • String

host[subscription_facet_attributes][autoheal]
任意 , nil可

Sets whether the Host will autoheal subscriptions upon checkin

Validations:

  • Must be one of: true, false, 1, 0.

host[subscription_facet_attributes][purpose_usage]
任意 , nil可

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_role]
任意 , nil可

Sets the system purpose usage

Validations:

  • String

host[subscription_facet_attributes][purpose_addons]
任意 , nil可

Sets the system add-ons

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][service_level]
任意 , nil可

Service level to be used for autoheal

Validations:

  • Integer

host[subscription_facet_attributes][hypervisor_guest_uuids]
任意 , nil可

List of hypervisor guest uuids

Validations:

  • Must be an array of any type

host[subscription_facet_attributes][installed_products_attributes]
任意 , nil可

List of products installed on the host

Validations:

  • Must be an Array of nested elements

host[subscription_facet_attributes][installed_products_attributes][product_id]
任意 , nil可

Product id as listed from a host's installed products, this is not the same product id as the products api returns

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][product_name]
任意 , nil可

Product name as listed from a host's installed products

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][arch]
任意 , nil可

Product architecture

Validations:

  • String

host[subscription_facet_attributes][installed_products_attributes][version]
任意 , nil可

Product version

Validations:

  • String


DELETE /api/hosts/:id
ホストの削除

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

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


GET /api/hosts/:id/enc
ホストの ENC 値の取得

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status
ホストの設定ステータスお取得

Return value may either be one of the following:

  • Alerts disabled

  • No reports

  • Error

  • Out of sync

  • Active

  • Pending

  • No changes

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


GET /api/hosts/:id/status/:type
ホストの状態の取得

Returns string representing a host status of a given type

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

type
必須

ステータスタイプ。以下のいずれか

  • global

  • configuration

  • build

Validations:

  • Must be one of: HostStatus::Global, configuration, build.


GET /api/hosts/:id/vm_compute_attributes
ホストの vm 属性の取得

Return the host's compute attributes that can be used to create a clone of this VM

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/disassociate
ホストの VM との関連付けを解除

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.


PUT /api/hosts/:id/power
ホストでパワー操作を実行します

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

power_action
必須

パワーアクション。有効なアクションは (on/start)、(off/stop)、(soft/reboot)、(cycle/reset)、(state/status) です。

Validations:

  • String


PUT /api/hosts/:id/boot
指定されたデバイスからホストを起動

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

device
必須

ブートデバイス。有効なデバイスはディスク、CDROM、PXE、BIOS です。

Validations:

  • String


POST /api/hosts/facts
ホストのファクトをアップロードし、必要な場合はホストを作成します

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

name
必須

ホストのホスト名

Validations:

  • String

facts
必須

ホストのファクトを含むハッシュ

Validations:

  • Hash

certname
任意

オプション: ホストの証明書名

Validations:

  • String

type
任意

オプション: 作成するホストの STI タイプ

Validations:

  • String


PUT /api/hosts/:id/rebuild_config
オーケストレーション設定の再ビルド

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

only
任意

再ビルドのステップの制限。有効なステップは DHCP, DNS, TFTP です。

Validations:

  • Must be an array of any type


GET /api/hosts/:id/template/:kind
テンプレートコンテンツのプロビジョニング中にプレビューがレンダリングされました

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

id
必須

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, dot(.), space, underscore(_), hypen(-) with no leading or trailing space.

kind
必須

テンプレート種類、利用可能な値:

Validations:

  • String


PUT /api/hosts/:host_id/host_collections
Alter a hosts host collections

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Integer

organization_id
任意

組織別のスコープ

Validations:

  • Integer

host_id
必須

The id of the host to alter

Validations:

  • Must be a number.

host_collection_ids
必須

List of host collection ids to update

Validations:

  • Must be an array of any type